[automake-commit] branch master updated: aclocal: add m4 search path info to --help

[Mike Frysinger]

This is an automated email from the git hooks/post-receive script.

vapier pushed a commit to branch master
in repository automake.

View the commit online:
https://git.savannah.gnu.org/gitweb/?p=automake.git;a=commitdiff;h=4c2c73bf72fdd060956dede8ece73504e8fc974f

The following commit(s) were added to refs/heads/master by this push:
     new 4c2c73bf7 aclocal: add m4 search path info to --help
4c2c73bf7 is described below

commit 4c2c73bf72fdd060956dede8ece73504e8fc974f
Author: Mike Frysinger <vapier@gentoo.org>
AuthorDate: Thu Jan 20 02:03:23 2022 -0500

    aclocal: add m4 search path info to --help
    
    Add a short summary to --help of the current paths that will be
    searched.  Make sure to omit this from the man page when running
    help2man since pre-inst-env specifically clears some and others
    to the current build directory.
    
    * bin/aclocal.in: Include m4 search paths in usage.
    * doc/local.mk: Run help2man with AUTOMAKE_HELP2MAN=true.
---
 bin/aclocal.in | 22 ++++++++++++++++++++--
 doc/local.mk   |  2 +-
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/bin/aclocal.in b/bin/aclocal.in
index 857e85308..77fbfd7e4 100644
--- a/bin/aclocal.in
+++ b/bin/aclocal.in
@@ -1044,12 +1044,30 @@ Options:
                               third-party m4 files, then exit
       --verbose             don't be silent
       --version             print version number, then exit
-  -W, --warnings=CATEGORY   report the warnings falling in CATEGORY
+  -W, --warnings=CATEGORY   report the warnings falling in CATEGORY,
+                              defaults to $WARNINGS
+
 EOF
 
   print Automake::ChannelDefs::usage (), "\n";
 
+  # This output depends on the current environment, and when generating the man
+  # pages during Automake compilation, the environment is set to local values.
+  # So don't include it in the installed man page.
+  if (!$ENV{AUTOMAKE_HELP2MAN}) {
+    print <<"EOF";
+
+Current m4 search paths (in order):
+  -I dirs:                  @user_includes
+  --automake-acdir:         @automake_includes
+  \$ACLOCAL_AUTOMAKE_DIR:    $ENV{"ACLOCAL_AUTOMAKE_DIR"}
+  \$ACLOCAL_PATH:            $ENV{"ACLOCAL_PATH"}
+  --system-acdir:           @system_includes
+EOF
+  }
+
   print <<'EOF';
+
 Report bugs to <@PACKAGE_BUGREPORT@>.
 GNU Automake home page: <@PACKAGE_URL@>.
 General help using GNU software: <https://www.gnu.org/gethelp/>.
@@ -1169,7 +1187,7 @@ if (exists $ENV{"AUTOMAKE_UNINSTALLED"})
 
 parse_WARNINGS;                    # Parse the WARNINGS environment variable.
 parse_arguments;
-parse_ACLOCAL_PATH;
+parse_ACLOCAL_PATH;        # Should come after parse arguments.
 $configure_ac = require_configure_ac;
 
 # We may have to rerun aclocal if some file have been installed, but
diff --git a/doc/local.mk b/doc/local.mk
index 06c78823a..921e22e9e 100644
--- a/doc/local.mk
+++ b/doc/local.mk
@@ -37,7 +37,7 @@ EXTRA_DIST += %D%/help2man
 update_mans = \
   $(AM_V_GEN): \
     && $(MKDIR_P) %D% \
-    && ./pre-inst-env $(PERL) $(srcdir)/%D%/help2man --output=$@
+    && AUTOMAKE_HELP2MAN=true ./pre-inst-env $(PERL) $(srcdir)/%D%/help2man 
--output=$@
 
 %D%/aclocal.1 %D%/automake.1:
        $(AM_V_GEN): \