1
0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-28 09:22:27 +01:00

check-doc: add an option to ignore some explicit options from the command's help

There are a few rare cases where some options listed in the program's
built-in help page may not be documented for a valid reason. This patch
provides an option to the checking script to not complain about them, but:

 - the listed options must include a comment about why, to ensure that the
user thinks twice about it and because it is better for maintainability;

 - the listed option must be part of the options listed by the application
to ensure the command line invocation of the script will remain up to date.

This new option is then used for the check of the "configure" options
because for a few of them the right place to document them is in the
INSTALL file provided by Autoconf and not in our Window Maker specific doc.

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
This commit is contained in:
Christophe CURIS
2015-04-06 17:58:09 +02:00
committed by Carlos R. Mafra
parent d1c9f791d8
commit 30fe0fb05f
2 changed files with 33 additions and 1 deletions

View File

@@ -96,6 +96,15 @@ check-local: configure-documentation
configure-documentation:
$(AM_V_CHKOPTS)$(top_srcdir)/script/check-cmdline-options-doc.sh \
--program "$(top_srcdir)/configure" --text-doc "$(top_srcdir)/INSTALL-WMAKER"
--program "$(top_srcdir)/configure" --text-doc "$(top_srcdir)/INSTALL-WMAKER" \
--ignore-prg 'with-PACKAGE,without-PACKAGE # only template names from Autoconf' \
--ignore-prg 'program-prefix,program-suffix,program-transform-name # in INSTALL' \
--ignore-prg 'version,quiet,srcdir,build,host,cache-file,no-create # in INSTALL' \
--ignore-prg 'enable-silent-rules,disable-silent-rules # should be in INSTALL' \
--ignore-prg 'enable-dependency-tracking,disable-dependency-tracking # in INSTALL' \
--ignore-prg 'enable-shared,enable-static # should be in INSTALL' \
--ignore-prg 'disable-option-checking,enable-fast-install # should be in INSTALL' \
--ignore-prg 'disable-libtool-lock,with-pic,with-gnu-ld,with-sysroot # for libtool' \
--ignore-prg 'with-x # no use, it would not work without X'
.PHONY: configure-documentation