Re: [PATCH v4 2/3] docs: improve send-email documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




> On 8 May 2025, at 8:23 PM, Junio C Hamano <gitster@xxxxxxxxx> wrote:
> 
> Junio C Hamano <gitster@xxxxxxxxx> writes:
> 
>>> I think ~/.gitconfig should be in single quotes, its not a command.
>> 
>> "Is this something the end-user would type verbatim?" is the criteria,
>> not "Is this a command name?".
> 
> Looking for "^Markup:" in Documentation/CodingGuidelines, we find a
> better description.
> 
> Literal parts (e.g. use of command-line options, command names,
> branch names, URLs, pathnames (files and directories), configuration and
> environment variables) must be typeset as verbatim (i.e. wrapped with
> backticks):
>   `--pretty=oneline`
>   `git rev-list`
>   `remote.pushDefault`
>   `http://git.example.com`
>   `.git/config`
>   `GIT_DIR`
>   `HEAD`
>   `umask`(2)
> 

I see. Since you have already queued the v5, can you do this change on your end,
or should I send a v6?

Also, if this is true, the docs need a review since I've found inconsistency across
many places.




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux