Skip to content

Various docs improvements

Glenn Washburn grub-devel 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest7 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/7docs: Fix spelling typo and remove unnecessary spacesdocs/grub-dev.texi+5 -50 replies
2/7docs: Make note that sendkey is only available on i386-pcdocs/grub.texi+3 -10 replies
3/7docs: Make note of i386-pc specific usage of halt commanddocs/grub.texi+4 -40 replies
4/7docs: Markup loader commands with @command tagdocs/grub.texi+4 -30 replies
5/7docs: Create command section for loader commandsdocs/grub.texi+116 -1040 replies
6/7docs: Add under documented loader commands to beginning of loader sectiondocs/grub.texi+36 -00 replies
7/7docs: Add section for general undocumented commandsdocs/grub.texi+101 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/7] Various docs improvements

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

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
section
docs: Add section for general undocumented commands

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