Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1jRyjb-000357-HB for mharc-grub-devel@gnu.org; Fri, 24 Apr 2020 09:51:15 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:41880) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jRyjZ-00034e-05 for grub-devel@gnu.org; Fri, 24 Apr 2020 09:51:13 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.90_1) (envelope-from ) id 1jRyjW-0002pn-PL for grub-devel@gnu.org; Fri, 24 Apr 2020 09:51:11 -0400 Received: from mailout01.mx.bawue.net ([193.7.176.62]:58985) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jRyjW-0002mu-2V for grub-devel@gnu.org; Fri, 24 Apr 2020 09:51:10 -0400 Received: from infty.fritz.box (p5B0825D9.dip0.t-ipconnect.de [91.8.37.217]) (Authenticated sender: pdim@bawue.de) by smtp.bawue.net (Postfix) with ESMTPSA id D64BC20603; Fri, 24 Apr 2020 15:51:02 +0200 (CEST) From: Hans Ulrich Niedermann To: grub-devel@gnu.org Cc: Hans Ulrich Niedermann Subject: [PATCH 0/3 v3] docs: Document list of undocumented commands Date: Fri, 24 Apr 2020 15:50:53 +0200 Message-Id: <20200424135056.445785-1-hun@n-dimensional.de> X-Mailer: git-send-email 2.25.3 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Virus-Scanner: SAV Dynamic Interface 2.6.0, Engine: 3.77.1, SAV: 5.74 (25B22A28) 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.62; envelope-from=hun@n-dimensional.de; helo=mailout01.mx.bawue.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/04/24 09:51:07 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Received-From: 193.7.176.62 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: Fri, 24 Apr 2020 13:51:13 -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 which were documented in grub.info but not implemented in the source code are removed from grub.texi in separate patches in the patchset. For conflict free merging, this patchset requires my gitignore patchset as it adds a gitignore pattern for the file it generates. The main differences to the previous versions ('' and 'v2) of this patchset are: * Added usage comments to the check-commands.py script * Use more descriptive variable names in check-commands.py * If a command is mentioned somewhere in grub.texi, we now add a remark about that to the autogenerated "this command is undocumented" documentation stub. 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 | 16 +++- docs/check-commands.py | 205 +++++++++++++++++++++++++++++++++++++++++ docs/grub.texi | 28 +----- 4 files changed, 223 insertions(+), 27 deletions(-) create mode 100644 docs/check-commands.py -- 2.25.3