From 31694ab9d337d68294a5710d55fc4f7e1ff6f83a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Fri, 19 Dec 2025 19:26:56 +0100 Subject: [PATCH 1/2] doc: fix asciidoc markup issues in several files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix incorrect use of backticks for markup in git-checkout.adoc, git-worktree.adoc * switch tabs to spaces in git-send-email.adoc list items Signed-off-by: Jean-Noël Avila --- Documentation/git-checkout.adoc | 2 +- Documentation/git-send-email.adoc | 14 +++++++------- Documentation/git-worktree.adoc | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/git-checkout.adoc b/Documentation/git-checkout.adoc index 6f281b298efac1..43ccf47cf6de28 100644 --- a/Documentation/git-checkout.adoc +++ b/Documentation/git-checkout.adoc @@ -509,7 +509,7 @@ ARGUMENT DISAMBIGUATION ----------------------- When you run `git checkout `, Git tries to guess whether -`` is intended to be a branch, a commit, or a set of file(s), +__ 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. diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc index 263b977353f334..caf9d693a33f4a 100644 --- a/Documentation/git-send-email.adoc +++ b/Documentation/git-send-email.adoc @@ -277,7 +277,7 @@ must be used for each option. --smtp-ssl:: Legacy alias for `--smtp-encryption ssl`. ---smtp-ssl-cert-path:: +--smtp-ssl-cert-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 @@ -510,12 +510,12 @@ 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, diff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc index f272f797837f45..d74ad7b0e9bd75 100644 --- a/Documentation/git-worktree.adoc +++ b/Documentation/git-worktree.adoc @@ -104,7 +104,7 @@ associated with a new unborn branch named __ (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`:: From a3a76d448ac2871834576be6d79e4704aae11f35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Fri, 19 Dec 2025 19:30:29 +0100 Subject: [PATCH 2/2] doc: correct minor wording issues MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 --- Documentation/git-rebase.adoc | 2 +- Documentation/git-repack.adoc | 6 +++--- Documentation/git-send-email.adoc | 12 ++++++------ 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc index 9742833ebe4207..e177808004fa81 100644 --- a/Documentation/git-rebase.adoc +++ b/Documentation/git-rebase.adoc @@ -87,7 +87,7 @@ 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 `ORIG_HEAD` (like `git reset`) are used during the rebase. The previous branch tip, however, is accessible using the reflog of the current branch (i.e. `@{1}`, -see linkgit:gitrevisions[7]. +see linkgit:gitrevisions[7]). TRANSPLANTING A TOPIC BRANCH WITH --ONTO ---------------------------------------- diff --git a/Documentation/git-repack.adoc b/Documentation/git-repack.adoc index d12c4985f61c06..673ce91083720d 100644 --- a/Documentation/git-repack.adoc +++ b/Documentation/git-repack.adoc @@ -77,14 +77,14 @@ to the new separate pack will be written. Only useful with `--cruft -d`. --max-cruft-size=:: - Overrides `--max-pack-size` for cruft packs. Inherits the value of + Override `--max-pack-size` for cruft packs. Inherits the value of `--max-pack-size` (if any) by default. See the documentation for `--max-pack-size` for more details. --combine-cruft-below-size=:: When generating cruft packs without pruning, only repack - existing cruft packs whose size is strictly less than ``, - where `` represents a number of bytes, which can optionally + existing cruft packs whose size is strictly less than `` + bytes, which can optionally be suffixed with "k", "m", or "g". Cruft packs whose size is greater than or equal to `` are left as-is and not repacked. Useful when you want to avoid repacking large cruft pack(s) in diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc index caf9d693a33f4a..cdaf421cda9ca9 100644 --- a/Documentation/git-send-email.adoc +++ b/Documentation/git-send-email.adoc @@ -208,7 +208,7 @@ Sending for your own case. Default is the value of `sendemail.smtpEncryption`. --smtp-domain=:: - Specifies the Fully Qualified Domain Name (FQDN) used in the + Specify the Fully Qualified Domain Name (FQDN) used in the HELO/EHLO command to the SMTP server. Some servers require the FQDN to match your IP address. If not set, `git send-email` attempts to determine your FQDN automatically. Default is the value of @@ -245,7 +245,7 @@ a password is obtained using linkgit:git-credential[1]. Disable SMTP authentication. Short hand for `--smtp-auth=none`. --smtp-server=:: - If set, specifies the outgoing SMTP server to use (e.g. + Specify the outgoing SMTP server to use (e.g. `smtp.example.com` or a raw IP address). If unspecified, and if `--sendmail-cmd` is also unspecified, the default is to search for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a @@ -258,7 +258,7 @@ command names. For those use cases, consider using `--sendmail-cmd` instead. --smtp-server-port=:: - Specifies a port different from the default port (SMTP + Specify a port different from the default port (SMTP servers typically listen to smtp port 25, but may also listen to submission port 587, or the common SSL smtp port 465); symbolic port names (e.g. `submission` instead of 587) @@ -266,7 +266,7 @@ instead. `sendemail.smtpServerPort` configuration variable. --smtp-server-option=