Skip to content

Conversation

@jnavila
Copy link

@jnavila jnavila commented Nov 16, 2025

This is the continuity of the conversion to the synopsis style with a few additional formatting changes.

Change since V1:
While proofreading again, I found a typo (extraneous underscore character).

@jnavila jnavila changed the title Doc git fetch doc: convert fetch pull push to synopsis style Nov 19, 2025
@jnavila
Copy link
Author

jnavila commented Nov 19, 2025

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 19, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2002/jnavila/doc_git_fetch-v1

To fetch this version to local tag pr-2002/jnavila/doc_git_fetch-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2002/jnavila/doc_git_fetch-v1

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 20, 2025

This patch series was integrated into seen via git@522de41.

@gitgitgadget gitgitgadget bot added the seen label Nov 20, 2025
@gitgitgadget
Copy link

gitgitgadget bot commented Nov 20, 2025

This patch series was integrated into seen via git@9ac6ac4.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 21, 2025

This branch is now known as ja/doc-synopsis-style.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 21, 2025

This patch series was integrated into seen via git@d121cd9.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 21, 2025

This patch series was integrated into next via git@eb9c170.

@gitgitgadget gitgitgadget bot added the next label Nov 21, 2025
@gitgitgadget
Copy link

gitgitgadget bot commented Nov 24, 2025

This patch series was integrated into seen via git@52f29f9.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 24, 2025

There was a status update in the "New Topics" section about the branch ja/doc-synopsis-style on the Git mailing list:

Doc mark-up updates.

Will merge to 'master'.
source: <[email protected]>

- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Signed-off-by: Jean-Noël Avila <[email protected]>
- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Signed-off-by: Jean-Noël Avila <[email protected]>
- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Signed-off-by: Jean-Noël Avila <[email protected]>
@jnavila
Copy link
Author

jnavila commented Nov 24, 2025

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 24, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2002/jnavila/doc_git_fetch-v2

To fetch this version to local tag pr-2002/jnavila/doc_git_fetch-v2:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2002/jnavila/doc_git_fetch-v2

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 24, 2025

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Jean-Noël Avila via GitGitGadget" <[email protected]> writes:

> Range-diff vs v1:
>
>  1:  397f56d874 ! 1:  994f6ee414 doc: convert git fetch to synopsis style
>      @@ Documentation/pull-fetch-param.adoc: namespace it's being fetched to, the type o
>        +
>        Until Git version 2.20, and unlike when pushing with
>        linkgit:git-push[1], any updates to `refs/tags/*` would be accepted
>      -@@ Documentation/pull-fetch-param.adoc: object.
>      - When the remote branch you want to fetch is known to
>      - be rewound and rebased regularly, it is expected that
>      - its new tip will not be a descendant of its previous tip
>      --(as stored in your remote-tracking branch the last time
>      -+(as stored in your remote-tracking branch the last time_
>      - you fetched).  You would want
>      - to use the `+` sign to indicate non-fast-forward updates
>      - will be needed for such branches.  There is no way to
>       @@ Documentation/pull-fetch-param.adoc: must know this is the expected usage pattern for a branch.
>        ifdef::git-pull[]

Ah, this was a spurious change that did not need to exist there, and
this round removes the whole thing.  Looks good.

>  2:  5b1e64bdf8 = 2:  6e9ea10311 doc: convert git pull to synopsis style
>  3:  e5526eaf58 = 3:  9c70b341bb doc: convert git push to synopsis style

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 24, 2025

This patch series was integrated into seen via git@a7e4ba4.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 25, 2025

This patch series was integrated into seen via git@1867c6d.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 25, 2025

This patch series was integrated into seen via git@fae8be5.

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 26, 2025

There was a status update in the "Cooking" section about the branch ja/doc-synopsis-style on the Git mailing list:

Doc mark-up updates.

Will merge to 'master'.
source: <[email protected]>

@gitgitgadget
Copy link

gitgitgadget bot commented Nov 26, 2025

This patch series was integrated into seen via git@b7c98fa.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant