git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "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] doc: git-add.txt: convert to new style convention
Date: Tue, 12 Nov 2024 09:38:25 +0900	[thread overview]
Message-ID: <xmqqserx8ewu.fsf@gitster.g> (raw)
In-Reply-To: <pull.1826.git.1731348891108.gitgitgadget@gmail.com> ("Jean-Noël Avila via GitGitGadget"'s message of "Mon, 11 Nov 2024 18:14:50 +0000")

"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
>
> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
> ---
>     doc: git-add.txt: convert to new style convention

This does slightly more than converting to new style, though,
doesn't it?  Is it so annoying to see a link that points at the same
page you are reading right now to warrant duplicating some docs with
conditional inclusion?

> +`add.ignoreErrors`::
> +`add.ignore-errors` (deprecated)::
> +	Tells `git add` to continue adding files when some files cannot be
> +	added due to indexing errors.
> +ifdef::git-add[]
> +	Equivalent to the `--ignore-errors` option.
> +endif::git-add[]
> +ifndef::git-add[]
> +	Equivalent to the `--ignore-errors` option of linkgit:git-add[1].
> +endif::git-add[]

>  SYNOPSIS
>  --------
> -[verse]
> -'git add' [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
> -	  [--edit | -e] [--[no-]all | -A | --[no-]ignore-removal | [--update | -u]] [--sparse]
> -	  [--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize]
> -	  [--chmod=(+|-)x] [--pathspec-from-file=<file> [--pathspec-file-nul]]
> -	  [--] [<pathspec>...]
> +[synopsis]
> +git add [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
> +	[--edit | -e] [--[no-]all | -A | --[no-]ignore-removal | [--update | -u]] [--sparse]
> +	[--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize]
> +	[--chmod=(+|-)x] [--pathspec-from-file=<file> [--pathspec-file-nul]]
> +	[--] [<pathspec>...]

Not having to worry about `mark-up` _rules_ in the synopsis section
is very nice ;-)


  reply	other threads:[~2024-11-12  0:38 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-11 18:14 [PATCH] doc: git-add.txt: convert to new style convention Jean-Noël Avila via GitGitGadget
2024-11-12  0:38 ` Junio C Hamano [this message]
2024-11-12  9:25   ` Jean-Noël Avila
2024-11-12 22:41     ` Junio C Hamano
2024-11-16 21:42 ` [PATCH v2] " Jean-Noël Avila via GitGitGadget

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqserx8ewu.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.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.
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 NNTP newsgroup(s).