git/list[1] front-page[2] threads[3] people[4] search[5] about
 

verifying syntax for optional and replaceable content in man pages

From
Robert P. J. Day <rpjday@crashcourse.ca>
Date
May 30, 2018, 11:39 UTC
Message-ID
<alpine.LFD.2.21.1805300733440.10096@localhost.localdomain>
  willing to submit some patches to standardize the syntax of man
pages in terms of rendering "optional" and/or "replaceable" content,
and it seems like "man git-config" would be a good place to start:
SYNOPSIS
       git config [<file-option>] [type] [--show-origin] [-z|--null] name [value [value_regex]]
       git config [<file-option>] [type] --add name value
       git config [<file-option>] [type] --replace-all name value [value_regex]
       ...snip ...
  can i assume the proper (uniform) syntax for the above would be
(shortening lines):
  ... [<type>] [--show-origin] [-z|--null] <name> [<value> [<value_regex>]]
  ... [<type>] --add <name> <value>
  ... [<type>] --replace-all <name> <value> [<value_regex>]

and so on. is that the consensus? i wouldn't try to do it all at once, maybe just a page at a time to not be too disruptive.

rday
-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                  http://crashcourse.ca/dokuwiki

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
Next: Stefan Beller
Message 1 of 3 in “verifying syntax for optional and replaceable content in man pages”
  1. Robert P. J. DayMay 30, 2018
  2. Stefan BellerMay 30, 2018
  3. Robert P. J. DayMay 30, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.