From: Glenn Washburn <development@efficientek.com>
To: grub-devel@gnu.org, Daniel Kiper <dkiper@net-space.pl>
Cc: Glenn Washburn <development@efficientek.com>
Subject: [PATCH 0/7] Various docs improvements
Date: Wed, 11 May 2022 21:56:17 -0500 [thread overview]
Message-ID: <cover.1652323528.git.development@efficientek.com> (raw)
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(-)
--
2.34.1
next reply other threads:[~2022-05-12 2:56 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-12 2:56 Glenn Washburn [this message]
2022-05-12 2:56 ` [PATCH 1/7] docs: Fix spelling typo and remove unnecessary spaces Glenn Washburn
2022-05-12 2:56 ` [PATCH 2/7] docs: Make note that sendkey is only available on i386-pc Glenn Washburn
2022-05-12 2:56 ` [PATCH 3/7] docs: Make note of i386-pc specific usage of halt command Glenn Washburn
2022-05-12 2:56 ` [PATCH 4/7] docs: Markup loader commands with @command tag Glenn Washburn
2022-05-12 2:56 ` [PATCH 5/7] docs: Create command section for loader commands Glenn Washburn
2022-05-12 2:56 ` [PATCH 6/7] docs: Add under documented loader commands to beginning of loader section Glenn Washburn
2022-05-12 2:56 ` [PATCH 7/7] docs: Add section for general undocumented commands Glenn Washburn
2022-05-19 18:43 ` [PATCH 0/7] Various docs improvements Daniel Kiper
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1652323528.git.development@efficientek.com \
--to=development@efficientek.com \
--cc=dkiper@net-space.pl \
--cc=grub-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.