git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Jean-Noël Avila" <avila.jn@gmail.com>
To: "Junio C Hamano" <gitster@pobox.com>,
	"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Jean-Noël Avila" <jn.avila@free.fr>
Subject: Re: [PATCH 6/6] doc: git-clone: format placeholders
Date: Mon, 11 Mar 2024 22:43:06 +0100	[thread overview]
Message-ID: <3c98b049-4eb8-4441-aae7-4789a8f74d9b@gmail.com> (raw)
In-Reply-To: <xmqqbk7ku2ak.fsf@gitster.g>

Le 11/03/2024 à 18:05, Junio C Hamano a écrit :
> "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>>  --bare::
>>  	Make a 'bare' Git repository.  That is, instead of
>> -	creating `<directory>` and placing the administrative
>> -	files in `<directory>/.git`, make the `<directory>`
>> +	creating _<directory>_ and placing the administrative
>> +	files in `<directory>/.git`, make the _<directory>_
> 
> It is hard to decide what the right thing to do is to the earlier
> one on this line, isn't it?  It is not fully verbatim, even though
> its "/.git" part is.
> 

Like the synopsys of the manpages, if there is a "constant" part in the
word, it is deemed to be verbatim. Only when the placeholder is standing
alone (usually the sentence is about it) must the placeholder be marked
up as emphasized.

Also, headers of description list needn't be marked up.

Maybe worth some additional rules in the guidelines...

> Everything else in this entire series looked good to my cursory
> read, but I'd appreciate extra sets of eyes, of course.
> 
> Thanks for working on this topic.

There are manpages that are really inconsistant, and even malformed
(such as gitremote-helpers), but the order of fixing will be to focus on
the most often viewed ones first.



      reply	other threads:[~2024-03-11 21:43 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-10 19:10 [PATCH 0/6] doc: rework doc files for git-init and git-clone Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 1/6] doc: git-init: format verbatim parts Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 2/6] doc: git-init: format placeholders Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 3/6] doc: git-init: rework definition lists Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 4/6] doc: git-init: rework config item init.templateDir Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 5/6] doc: git-clone: format verbatim words Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 6/6] doc: git-clone: format placeholders Jean-Noël Avila via GitGitGadget
2024-03-11 17:05   ` Junio C Hamano
2024-03-11 21:43     ` Jean-Noël Avila [this message]

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=3c98b049-4eb8-4441-aae7-4789a8f74d9b@gmail.com \
    --to=avila.jn@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    --cc=jn.avila@free.fr \
    /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).