From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
To: "Josh Soref" <gitgitgadget@gmail•com>, git@vger•kernel.org
Cc: "Jean-Noël AVILA" <jn.avila@free•fr>
Subject: Re: [PATCH v2 0/2] doc: flock of small fixes to various documentation files
Date: Sun, 21 Dec 2025 18:12:59 +0100 [thread overview]
Message-ID: <2e6759b7-73b3-4098-a0d8-2dfa1b7a3c44@app.fastmail.com> (raw)
In-Reply-To: <pull.2016.v2.git.1766170456.gitgitgadget@gmail.com>
On Fri, Dec 19, 2025, at 19:54, Jean-Noël Avila via GitGitGadget wrote:
> This second version only splits the changes in two commits, one addressing
> asciidoc markup, the other fixing basic style issues.
>[snip]
> Range-diff vs v1:
>
> -: ---------- > 1: 31694ab9d3 doc: fix asciidoc markup issues in
> several files
> 1: b88126ef60 ! 2: a3a76d448a doc: flock of small fixes to various
> documentation files
> @@ Metadata
> Author: Jean-Noël Avila <jn.avila@free•fr>
>
> ## Commit message ##
> - doc: flock of small fixes to various documentation files
> + doc: correct minor wording issues
>
> - While translating the Git documentation into French, I
> noticed several small
> - issues in various files. This commit addresses these issues
> to improve the
> - overall quality and consistency of the documentation.
> -
> - * enforce consistent imperative mood in option descriptions
> - * lighten wording in several places for clarity
> - * add missing parameters
> - * fix minor asciidoc markup issues
> + * use imperative mood for consistency in options descriptions
> + * add missing parenthesis
> + * reword verbose phrase in git-repack.adoc
>
> Signed-off-by: Jean-Noël Avila <jn.avila@free•fr>
>
> - ## Documentation/git-checkout.adoc ##
> -@@ Documentation/git-checkout.adoc: ARGUMENT DISAMBIGUATION
> - -----------------------
> -
> - When you run `git checkout <something>`, Git tries to guess
> whether
> --`<something>` is intended to be a branch, a commit, or a set of
> file(s),
> -+_<something>_ is intended to be a branch, a commit, or a set of
> file(s),
> - and then either switches to that branch or commit, or restores
> the
> - specified files.
> -
> -
> ## Documentation/git-rebase.adoc ##
> @@ Documentation/git-rebase.adoc: of the to-be-rebased branch.
> However, `ORIG_HEAD` is not guaranteed to still
> point to that commit at the end of the rebase if other commands
> that change
> @@ Documentation/git-send-email.adoc: instead.
> Default value can be specified by the
> `sendemail.smtpServerOption`
> configuration option.
> +
> -@@ Documentation/git-send-email.adoc: must be used for each
> option.
> - --smtp-ssl::
> - Legacy alias for `--smtp-encryption ssl`.
> -
> ----smtp-ssl-cert-path::
> -+--smtp-ssl-cert-path <path>::
> - Path to a store of trusted CA certificates for SMTP SSL/TLS
> - certificate validation (either a directory that has been
> processed
> - by `c_rehash`, or a single file containing one or more PEM
> format
> @@ Documentation/git-send-email.adoc: Automating
> --no-to::
> --no-cc::
> @@ Documentation/git-send-email.adoc: Automating
> via config, if any.
>
> --to-cmd=<command>::
> -@@ Documentation/git-send-email.adoc: have been specified, in
> which case default to `compose`.
> - Currently, validation means the following:
> - +
> - --
> -- * Invoke the sendemail-validate hook if present (see
> linkgit:githooks[5]).
> -- * Warn of patches that contain lines longer than
> -- 998 characters unless a suitable transfer encoding
> -- (`auto`, `base64`, or `quoted-printable`) is used;
> -- this is due to SMTP limits as described by
> -- https://www.ietf.org/rfc/rfc5322.txt.
> -+* Invoke the sendemail-validate hook if present (see
> linkgit:githooks[5]).
> -+* Warn of patches that contain lines longer than
> -+ 998 characters unless a suitable transfer encoding
> -+ (`auto`, `base64`, or `quoted-printable`) is used;
> -+ this is due to SMTP limits as described by
> -+ https://www.ietf.org/rfc/rfc5322.txt.
> - --
> - +
> - Default is the value of `sendemail.validate`; if this is not set,
> -
> - ## Documentation/git-worktree.adoc ##
> -@@ Documentation/git-worktree.adoc: associated with a new unborn
> branch named _<branch>_ (after
> - passed to the command. In the event the repository has a remote
> and
> - `--guess-remote` is used, but no remote or local branches exist,
> then the
> - command fails with a warning reminding the user to fetch from
> their remote
> --first (or override by using `-f/--force`).
> -+first (or override by using `-f`/`--force`).
> -
> - `list`::
> -
>
> --
> gitgitgadget
Naturally a misleading range-diff. It’s the same change as last
round but split up into two commits.
This looks good to me. Thanks!
prev parent reply other threads:[~2025-12-21 17:13 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-15 20:23 [PATCH] doc: flock of small fixes to various documentation files Jean-Noël Avila via GitGitGadget
2025-12-15 22:50 ` Kristoffer Haugsbakk
2025-12-17 13:45 ` Jean-Noël Avila
2025-12-18 8:05 ` Kristoffer Haugsbakk
2025-12-19 9:34 ` Kristoffer Haugsbakk
2025-12-19 18:54 ` [PATCH v2 0/2] " Jean-Noël Avila via GitGitGadget
2025-12-19 18:54 ` [PATCH v2 1/2] doc: fix asciidoc markup issues in several files Jean-Noël Avila via GitGitGadget
2025-12-21 17:13 ` Kristoffer Haugsbakk
2025-12-19 18:54 ` [PATCH v2 2/2] doc: correct minor wording issues Jean-Noël Avila via GitGitGadget
2025-12-21 17:13 ` Kristoffer Haugsbakk
2025-12-22 4:42 ` Junio C Hamano
2025-12-21 17:12 ` Kristoffer Haugsbakk [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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2e6759b7-73b3-4098-a0d8-2dfa1b7a3c44@app.fastmail.com \
--to=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitgitgadget@gmail$(echo .)com \
--cc=jn.avila@free$(echo .)fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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