doc: flock of small fixes to various documentation files

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

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-checkout.adoc b/Documentation/git-checkout.adoc
index 6f281b298efac1393ed2301958e05c9661339ed2..43ccf47cf6de285aedd4e448ee862b57b054714c 100644 (file)
--- a/Documentation/git-checkout.adoc
+++ b/Documentation/git-checkout.adoc
@@ -509,7 +509,7 @@ 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.
 

diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
index 005caf61646ec74a448000564ca75038bb342142..ecc347680c3d6356439bb3f6f6c73b36838ba550 100644 (file)
--- 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 d12c4985f61c06d56bf68b16585727c6a702298e..673ce91083720d2fb1b6edf7fc5267b96c1a1042 100644 (file)
--- 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=<n>::
-       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=<n>::
        When generating cruft packs without pruning, only repack
-       existing cruft packs whose size is strictly less than `<n>`,
-       where `<n>` represents a number of bytes, which can optionally
+       existing cruft packs whose size is strictly less than `<n>`
+       bytes, which can optionally
        be suffixed with "k", "m", or "g". Cruft packs whose size is
        greater than or equal to `<n>` 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 263b977353f3341e5dd09d165603858a16064738..cdaf421cda9ca9a03f44e0aaa02cbc668ec7ac58 100644 (file)
--- 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=<FQDN>::
-       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=<host>::
-       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=<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=<option>::
-       If set, specifies the outgoing SMTP server option to use.
+       Specify the outgoing SMTP server option to use.
        Default value can be specified by the `sendemail.smtpServerOption`
        configuration option.
 +
@@ -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>::
        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
@@ -347,11 +347,11 @@ Automating
 --no-to::
 --no-cc::
 --no-bcc::
-       Clears any list of `To:`, `Cc:`, `Bcc:` addresses previously
+       Clear any list of `To:`, `Cc:`, `Bcc:` addresses previously
        set via config.
 
 --no-identity::
-       Clears the previously read value of `sendemail.identity` set
+       Clear the previously read value of `sendemail.identity` set
        via config, if any.
 
 --to-cmd=<command>::
@@ -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 f272f797837f454ea286cc9939929d6d42c8d6a8..d74ad7b0e9bd75cc68b898d4a7d2e302e2df74ba 100644 (file)
--- a/Documentation/git-worktree.adoc
+++ b/Documentation/git-worktree.adoc
@@ -104,7 +104,7 @@ 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`::