docs: Document list of undocumented commands
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v4 Latest3 patches 3 repliesIn review
- v33 patches 1 replySuperseded
- v21 of 3 patches 0 repliesSuperseded
Earlier versions · 1
| Version | Posted | Patches | Replies | Status |
|---|---|---|---|---|
| v1 | 2 of 3 patches | 1 reply | Superseded |
Patches in v4 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/3 | docs: Add grub command documentation checks.gitignore docs/ docs/ +1 more | +225 | 1 reply | |
| 2/3 | docs: Remove docs for non-existing pxe_unload commanddocs/ | +0 | 1 reply | |
| 3/3 | docs: Remove docs for non-existing uppermem commanddocs/ | +0 | 1 reply |
Reviews trailers per patch
All 3 patches have a Reviewed-by or Acked-by.
| Patch | Daniel Kiper | Alex Burmashev |
|---|---|---|
| 1/3 | R-b | |
| 2/3 | R-b | |
| 3/3 | R-b |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
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
@@ -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