[PATCH v2 0/2] doc: flock of small fixes to various documentation files
- From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Dec 19, 2025, 18:54 UTC
- Message-ID
- <pull.2016.v2.git.1766170456.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.2016.git.1765830229824.gitgitgadget@gmail.com>
This second version only splits the changes in two commits, one addressing asciidoc markup, the other fixing basic style issues.
Jean-Noël Avila (2): doc: fix asciidoc markup issues in several files doc: correct minor wording issues
Documentation/git-checkout.adoc | 2 +- Documentation/git-rebase.adoc | 2 +- Documentation/git-repack.adoc | 6 +++--- Documentation/git-send-email.adoc | 26 +++++++++++++------------- Documentation/git-worktree.adoc | 2 +- 5 files changed, 19 insertions(+), 19 deletions(-)
base-commit: d8af7cadaa79d5837d73ec949e10b57dedb43e9b Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2016%2Fjnavila%2Fdoc_small_fixups-v2 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2016/jnavila/doc_small_fixups-v2 Pull-Request: https://github.com/gitgitgadget/git/pull/2016
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