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

Re: [PATCH] doc: git-add.txt: convert to new style convention

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 12, 2024, 00:38 UTC
Message-ID
<xmqqserx8ewu.fsf@gitster.g>
In-Reply-To
<pull.1826.git.1731348891108.gitgitgadget@gmail.com>
"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 5 quoted lines
> 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?

Show 10 quoted lines
> +`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[]
Show 14 quoted lines
>  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 ;-)

Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël Avila
Message 2 of 5 in “doc: git-add.txt: convert to new style convention”
  1. doc: git-add.txt: convert to new style conventionJean-Noël Avila via GitGitGadget, Nov 11, 2024
  2. Junio C HamanoNov 12, 2024
  3. Jean-Noël AvilaNov 12, 2024
  4. Junio C HamanoNov 12, 2024
  5. doc: git-add.txt: convert to new style conventionJean-Noël Avila via GitGitGadget, Nov 16, 2024

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.