[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 0/3 v3] docs: Document list of undocumented commands

From: Hans Ulrich Niedermann
Subject: [PATCH 0/3 v3] docs: Document list of undocumented commands
Date: Fri, 24 Apr 2020 15:50:53 +0200

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 and documents
the differences.

For that matter, the script will autogenerate a list of the
undocumented commands to be included in, 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 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 script

  * Use more descriptive variable names in

  * 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/       |  16 +++-
 docs/ | 205 +++++++++++++++++++++++++++++++++++++++++
 docs/grub.texi         |  28 +-----
 4 files changed, 223 insertions(+), 27 deletions(-)
 create mode 100644 docs/


reply via email to

[Prev in Thread] Current Thread [Next in Thread]