From: Firmin Martin <firminmartin24@gmail.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Git Users <git@vger.kernel.org>
Subject: Re: [RFC PATCH v1 01/13] doc: typeset command-line options in monospace
Date: Sat, 10 Apr 2021 03:12:44 +0200 [thread overview]
Message-ID: <87r1jjgcxf.fsf@Inspiron.i-did-not-set--mail-host-address--so-tickle-me> (raw)
In-Reply-To: <8a44cb3d-d1ce-a3dc-82da-69a65d5baac2@gmail.com>
Hi Bagas,
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> On 09/04/21 11.02, Firmin Martin wrote:
>> help.browser, web.browser and browser.<tool>.path
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> The `help.browser`, `web.browser` and `browser.<tool>.path` will also
>> be checked if the 'web' format is chosen (either by command-line
>> -option or configuration variable). See '-w|--web' in the OPTIONS
>> +option or configuration variable). See `-w`|`--web` in the OPTIONS
>
> Why not `-w | --web`?
Good question.
There are multiple justifications:
- The "|" is a meta-character not included in the option name.
- If you run
grep -Pn "'.*\|.*?'" *.txt
under the Documentation/ directory, you will notice that we have
already done something like this, but in italic:
- In git-rerere.txt's Synopsis: `git rerere` ['clear'|'forget' <pathspec>|'diff'|'remaining'|'status'|'gc']
- In gitremote-helpers.txt: 'option dry-run' {'true'|'false'}:
- That is exactly what "man man" or some other man pages do (e.g. "man
tar"). Of course, some man pages do not follow this convention
(e.g. "man 7z").
Best,
Firmin
>
> --
> An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2021-04-10 1:12 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
2021-04-09 9:49 ` Bagas Sanjaya
2021-04-10 1:12 ` Firmin Martin [this message]
2021-04-09 4:02 ` [RFC PATCH v1 02/13] doc: typeset branches and remotes " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 03/13] doc: typeset configuration options " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 04/13] doc: typeset git-related commands " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 05/13] doc: typeset git-svn subcommands " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 06/13] doc: typeset dummy URLs and protocols " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 07/13] doc: typeset git dotfiles " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 08/13] doc: typeset filepath and $variables " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 09/13] doc: typeset command/option/value entries " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 10/13] doc: typeset more command " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 11/13] doc: typeset config option " Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 12/13] doc: typeset environment vars without $ " Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 13/13] doc: typeset common programs " Firmin Martin
2021-04-12 13:37 ` [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Jean-Noël Avila
2021-04-13 20:42 ` Firmin Martin
2021-04-19 9:04 ` Jean-Noël Avila
2021-04-19 9:33 ` Jean-Noël Avila
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r1jjgcxf.fsf@Inspiron.i-did-not-set--mail-host-address--so-tickle-me \
--to=firminmartin24@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).