mbox series

[v2,0/7] doc: convert git-reset, git-rm and git-mv to new documentation format

Message ID pull.1896.v2.git.1744460450.gitgitgadget@gmail.com (mailing list archive)
Headers show
Series doc: convert git-reset, git-rm and git-mv to new documentation format | expand

Message

Philippe Blain via GitGitGadget April 12, 2025, 12:20 p.m. UTC
doc: convert git-reset, git-rm and git-mv to new documentation format

change since V1:

 * fix remarks from reviewers
 * stack the commit fixing the handling of three-dot notation

Jean-Noël Avila (7):
  doc: convert git-reset to new documentation format
  doc: fix synopsis analysis logic
  doc: convert git-rm to new documentation format
  doc: move synopsis git-mv commands in the synopsis section
  doc: convert git-mv to new documentation format
  doc: fix asciidoctor synopsis processing of triple-dots
  doc: add markup for characters in Guidelines

 Documentation/CodingGuidelines             |  3 +
 Documentation/asciidoc.conf.in             |  8 +-
 Documentation/asciidoctor-extensions.rb.in | 12 +--
 Documentation/git-mv.adoc                  | 33 ++++----
 Documentation/git-reset.adoc               | 98 +++++++++++-----------
 Documentation/git-rm.adoc                  | 56 ++++++-------
 builtin/mv.c                               |  3 +-
 7 files changed, 109 insertions(+), 104 deletions(-)


base-commit: 485f5f863615e670fd97ae40af744e14072cfe18
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1896%2Fjnavila%2Fdoc_git_reset-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1896/jnavila/doc_git_reset-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1896

Range-diff vs v1:

 1:  1676b5ac628 ! 1:  5a6c7def260 doc: convert git-reset to new documentation format
     @@ Documentation/git-reset.adoc: and specifying a commit with `--source`, you
      +`--soft`::
       	Does not touch the index file or the working tree at all (but
      -	resets the head to `<commit>`, just like all modes do). This leaves
     --	all your changed files "Changes to be committed", as `git status`
      +	resets the head to _<commit>_, just like all modes do). This leaves
     -+	all your changed files "Changes to be committed", as `git status
     + 	all your changed files "Changes to be committed", as `git status`
       	would put it.
       
      ---mixed::
 2:  6206e65ac4d = 2:  440eac1f974 doc: fix synopsis analysis logic
 3:  41a01969d93 = 3:  6814e98f71d doc: convert git-rm to new documentation format
 4:  9f7cd02cc1e = 4:  2a129734e3d doc: move synopsis git-mv commands in the synopsis section
 5:  4887567c57c ! 5:  1868dfc3282 doc: convert git-mv to new documentation format
     @@ Documentation/git-mv.adoc: git-mv - Move or rename a file, a directory, or a sym
      +
      +[synopsis]
      +git mv [-v] [-f] [-n] [-k] <source> <destination>
     -+git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>
     ++git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>
       
       DESCRIPTION
       -----------
     @@ Documentation/git-mv.adoc: SUBMODULES
       
       BUGS
       ----
     +
     + ## builtin/mv.c ##
     +@@
     + 
     + static const char * const builtin_mv_usage[] = {
     + 	N_("git mv [-v] [-f] [-n] [-k] <source> <destination>"),
     +-	N_("git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>"),
     ++	N_("git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>"),
     + 	NULL
     + };
     + 
 -:  ----------- > 6:  2ddce76f14d doc: fix asciidoctor synopsis processing of triple-dots
 -:  ----------- > 7:  2690f84602b doc: add markup for characters in Guidelines

Comments

Junio C Hamano April 14, 2025, 9:47 p.m. UTC | #1
"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:

> doc: convert git-reset, git-rm and git-mv to new documentation format
>
> change since V1:
>
>  * fix remarks from reviewers
>  * stack the commit fixing the handling of three-dot notation
>
> Jean-Noël Avila (7):
>   doc: convert git-reset to new documentation format
>   doc: fix synopsis analysis logic
>   doc: convert git-rm to new documentation format
>   doc: move synopsis git-mv commands in the synopsis section
>   doc: convert git-mv to new documentation format

It was very obvious that the updates for the above relative to the
previous iteration are all good ones.

>   doc: fix asciidoctor synopsis processing of triple-dots

I'll need to look at this a bit carefully, as regexp over
<mark><up><language><input> tend to become pure gibberish ;-)

>   doc: add markup for characters in Guidelines

Looking good.

Will queue.  Thanks.