]> sourceware.org Git - newlib-cygwin.git/commit
Cygwin: Use cmdsynopsis element in utils documentation
authorJon Turney <jon.turney@dronecode.org.uk>
Mon, 14 Jun 2021 12:51:41 +0000 (13:51 +0100)
committerJon Turney <jon.turney@dronecode.org.uk>
Fri, 9 Jul 2021 12:21:18 +0000 (13:21 +0100)
commite6b667f1a473369ed3aca00de26cf2efa09193cd
tree860f1813ddaadcaf2dee56e57ce2eb15157d8251
parentbe4a8b91ff7b30b651630fbf65f7014bd3972b6f
Cygwin: Use cmdsynopsis element in utils documentation

Use <cmdsynopsis> element markup in utils docbook documentation, rather
than some preformatted text inside <screen>.

(This didn't happen as part of 646745cb, when we first started using
refentry elements to make it possible to generate manpages)

This helps produce better looking manpages:

* uses bold (for command names) and italic (for replaceable items)
* different output formats inconsistently treat tabs inside <screen>
(so we have to be careful to not use them in that preformatted text)

Also clean up various issues:

* Replace '[OPTIONS]' with a real synopsis of the options
* Consistently use 'ITEM...' rather than 'ITEM1 [ITEM2...]' for an item
which should appear 1 or more times (cygcheck -f, getfacl, kill)
* Consistently document the '-h | -V' invocation form
* Since replaceable items are now marked up so they have some formatting
indicating they are replaceable, we can drop wrapping them in angle
brackets, as is done in some places
* Add missing '-W' and '-p PID' options to ps synopsis
* Adjust cygpath synopsis to show that only one 'System information'
option is allowed, possibly modified by -A

Future work:
* Sync up the actual help emitted by the util, where it's been improved
* Also don't use <screen> for formatting 'OPTIONS' section of manpage
* pldd inconsistently uses '-?' rather than '-h'!
winsup/doc/utils.xml
This page took 0.029611 seconds and 5 git commands to generate.