Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1jXv7k-0004nn-Sj for mharc-grub-devel@gnu.org; Sun, 10 May 2020 19:12:44 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:45784) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jXv7j-0004nf-8k for grub-devel@gnu.org; Sun, 10 May 2020 19:12:43 -0400 Received: from mailout02.mx.bawue.net ([193.7.176.63]:47872) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jXv7h-00062C-QI for grub-devel@gnu.org; Sun, 10 May 2020 19:12:42 -0400 Received: from infty.fritz.box (p5B17584C.dip0.t-ipconnect.de [91.23.88.76]) (Authenticated sender: pdim@bawue.de) by smtp.bawue.net (Postfix) with ESMTPSA id E69362046F; Mon, 11 May 2020 01:12:33 +0200 (CEST) From: Hans Ulrich Niedermann To: grub-devel@gnu.org Cc: Hans Ulrich Niedermann Subject: [PATCH v4 0/3] docs: Document list of undocumented commands Date: Mon, 11 May 2020 01:12:28 +0200 Message-Id: <20200510231232.269459-1-hun@n-dimensional.de> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Virus-Scanner: SAV Dynamic Interface 2.6.0, Engine: 3.77.1, SAV: 5.74 (1EAE2D44) on relay01.mx.bawue.net using milter-sssp 0.1.0 X-Virus-Scan: Found to be clean. Received-SPF: pass client-ip=193.7.176.63; envelope-from=hun@n-dimensional.de; helo=mailout02.mx.bawue.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/05/10 19:12:37 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 10 May 2020 23:12:43 -0000 This patchset adds a script to the buildsystem which determines the lists of GRUB commands implemented in the source code and the list of GRUB commands documented in grub.info and documents the differences. For that matter, the script will autogenerate a list of the undocumented commands to be included in grub.info, so that the undocumented commands are at least listed there so users have a point to start researching. If the command is at least mentioned somewhere withing grub.texi, that will be noted. The two commands pxe_unload and uppermem which were documented in grub.info but not implemented in the source code are removed from grub.texi in separate patches in the patchset. The long term goal of this is to reduce the number of undocumented GRUB commands to zero and to keep it there. For conflict free merging, this patchset requires my gitignore patchset as it adds a gitignore pattern for the file it generates. Hans Ulrich Niedermann (3): docs: Add grub command documentation checks docs: Remove docs for non-existing pxe_unload command docs: Remove docs for non-existing uppermem command .gitignore | 1 + docs/Makefile.am | 18 +++- docs/check-commands.py | 205 +++++++++++++++++++++++++++++++++++++++++ docs/grub.texi | 28 +----- 4 files changed, 225 insertions(+), 27 deletions(-) create mode 100644 docs/check-commands.py Interdiff: diff --git a/docs/Makefile.am b/docs/Makefile.am index 8e8500226..a8009e7a9 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -6,10 +6,12 @@ grub_TEXINFOS = fdl.texi undocumented-commands.texi EXTRA_DIST = check-commands.py font_char_metrics.png font_char_metrics.txt +# This has only been tested to work without the Automake +# info-in-builddir option. CLEANFILES = undocumented-commands.texi BUILT_SOURCES = update-undoc update-undoc: - $(PYTHON) check-commands.py > undocumented-commands.texi.tmp + $(PYTHON) $(srcdir)/check-commands.py > undocumented-commands.texi.tmp @if test -f $(srcdir)/undocumented-commands.texi && $(CMP) undocumented-commands.texi.tmp $(srcdir)/undocumented-commands.texi; then \ echo "Not updating undocumented-commands.texi: is up to date"; \ rm -f undocumented-commands.texi.tmp; \ -- 2.26.2