[Top][All Lists]

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

[PATCH 0/7] Various docs improvements

From: Glenn Washburn
Subject: [PATCH 0/7] Various docs improvements
Date: Wed, 11 May 2022 21:56:17 -0500

The first 4 patches need no explanation. The 5th patch creates a new section
just for loader commands and moves loader commands to that section from the
general commands section. Patch #6 adds an itemized list of currently
under-documented loader commands to the text part of the loader command
section. And patch #7 adds a new section for undocumented commands and
contains an itemized list of undocumented commands (now minimally documented!)

These two lists of undocumented commands was partially generated by grepping
for command registration in the source and pulling out the registered command
name and help string. The hope is that these two lists will make it easier for
non-programmers (or anyone) to contribute to GRUB by choosing a command to
flesh out. Also, I wanted this list so that I have a way to quickly see all
the available commands to choose potentially interesting ones for use. So
far I've found some commands that I didn't know existed.

I don't particularly like how patch #6 renders to html, with the justification
of the two itemized lists (one of the undocumented loader commands and the
other the documented loader commands) being different. I'm open to suggestiong
on how this might be improved.


Glenn Washburn (7):
  docs: Fix spelling typo and remove unnecessary spaces
  docs: Make note that sendkey is only available on i386-pc
  docs: Make note of i386-pc specific usage of halt command
  docs: Markup loader commands with @command tag
  docs: Create command section for loader commands
  docs: Add under documented loader commands to beginning of loader
  docs: Add section for general undocumented commands

 docs/grub-dev.texi |  10 +-
 docs/grub.texi     | 376 +++++++++++++++++++++++++++++++--------------
 2 files changed, 269 insertions(+), 117 deletions(-)


reply via email to

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