Skip to content

docs: Document list of undocumented commands

Hans Ulrich Niedermann grub-devel 4 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest3 patches 3 repliesIn review
  2. v33 patches 1 replySuperseded
  3. v21 of 3 patches 0 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v12 of 3 patches1 replySuperseded

Patches in v4 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3docs: Add grub command documentation checks.gitignore docs/Makefile.am docs/check-commands.py +1 more+225 -31 reply
2/3docs: Remove docs for non-existing pxe_unload commanddocs/grub.texi+0 -111 reply
3/3docs: Remove docs for non-existing uppermem commanddocs/grub.texi+0 -131 reply

Reviews trailers per patch

All 3 patches have a Reviewed-by or Acked-by.

PatchDaniel KiperAlex Burmashev
1/3R-b
2/3R-b
3/3R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v4 thread

Cover letter [PATCH v4 0/3] docs: Document list of undocumented commands

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:

docs/Makefile.am +3 -1
index 8e8500226..a8009e7a9 100644
@@ -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; \
Signature · 1 line
2.26.2