From d8da119ea1f0ba35379ec11921473e262b0111a0 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 3 Aug 2022 19:35:45 +0200
Subject: [PATCH] Remove doxygen log file if it's empty in the helper script

This allows to avoid having an untracked file in the repository, so it
doesn't need to be ignored any longer, as it shouldn't exist after a
successful run.

Also output a warning if the log file is not empty, even though the full
dump is only shown in the GitHub workflow file, as when running the
script locally it may be more convenient to examine the log file in some
other way.
---
 .github/workflows/docs_update.yml |  2 +-
 .gitignore                        |  1 -
 docs/doxygen/regen.sh             | 11 +++++++++--
 3 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/docs_update.yml b/.github/workflows/docs_update.yml
index 277014cc05..3b6bdc79ed 100644
--- a/.github/workflows/docs_update.yml
+++ b/.github/workflows/docs_update.yml
@@ -45,7 +45,7 @@ jobs:
         run: |
           ./regen.sh php
           if [[ -s doxygen.log ]]; then
-            echo '*** There were warnings during docs generation: ***'
+            echo 'Contents of Doxygen log file follows:'
             echo '-----------------------------------------------------------'
             cat doxygen.log
             echo '-----------------------------------------------------------'
diff --git a/.gitignore b/.gitignore
index aecf49e324..17bcc0d809 100644
--- a/.gitignore
+++ b/.gitignore
@@ -157,7 +157,6 @@
 /distrib/release
 
 # /docs/doxygen/
-/docs/doxygen/doxygen.log
 /docs/doxygen/out
 
 # /include/
diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh
index ad9f6e4f98..5b158c86d5 100755
--- a/docs/doxygen/regen.sh
+++ b/docs/doxygen/regen.sh
@@ -239,5 +239,12 @@ fi
 # Doxygen has the annoying habit to put the full path of the
 # affected files in the log file; remove it to make the log
 # more readable
-topsrcdir=`cd ../.. && pwd`
-sed -i'' -e "s|$topsrcdir/||g" doxygen.log
+if [[ -s doxygen.log ]]; then
+    topsrcdir=`cd ../.. && pwd`
+    sed -i'' -e "s|$topsrcdir/||g" doxygen.log
+
+    echo '*** There were warnings during docs generation ***'
+else
+    # Don't leave empty file lying around.
+    rm doxygen.log
+fi