Documentation: stylistically normalize references to Signed-off-by:

Ted reported an old typo in the git-commit.txt and merge-options.txt.
Namely, the phrase "Signed-off-by line" was used without either a
definite nor indefinite article.

Upon examination, it seems that the documentation (including items in
Documentation/, but also option help strings) have been quite
inconsistent on usage when referring to `Signed-off-by`.

First, very few places used a definite or indefinite article with the
phrase "Signed-off-by line", but that was the initial typo that led
to this investigation.  So, normalize using either an indefinite or
definite article consistently.

The original phrasing, in Commit 3f971fc425b (Documentation updates,
2005-08-14), is "Add Signed-off-by line".  Commit 6f855371a53 (Add
--signoff, --check, and long option-names. 2005-12-09) switched to
using "Add `Signed-off-by:` line", but didn't normalize the former
commit to match.  Later commits seem to have cut and pasted from one
or the other, which is likely how the usage became so inconsistent.

Junio stated on the git mailing list in
<xmqqy2k1dfoh.fsf@gitster.c.googlers.com> a preference to leave off
the colon.  Thus, prefer `Signed-off-by` (with backticks) for the
documentation files and Signed-off-by (without backticks) for option
help strings.

Additionally, Junio argued that "trailer" is now the standard term to
refer to `Signed-off-by`, saying that "becomes plenty clear that we
are not talking about any random line in the log message".  As such,
prefer "trailer" over "line" anywhere the former word fits.

However, leave alone those few places in documentation that use
Signed-off-by to refer to the process (rather than the specific
trailer), or in places where mail headers are generally discussed in
comparison with Signed-off-by.

Reported-by: "Theodore Y. Ts'o" <tytso@mit.edu>
Signed-off-by: Bradley M. Kuhn <bkuhn@sfconservancy.org>
Acked-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 4f85a089ef9d99e868dd1550992ac234e13266ff..492f3998f719291787cd05e4559a50bd49677c73 100644 (file)
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -249,7 +249,7 @@ component you're working on, followed by a blank line (always required) and then
 the body of your commit message, which should provide the bulk of the context.
 Remember to be explicit and provide the "Why" of your change, especially if it
 couldn't easily be understood from your diff. When editing your commit message,
-don't remove the Signed-off-by line which was added by `-s` above.
+don't remove the `Signed-off-by` trailer which was added by `-s` above.
 
 ----
 psuh: add a built-in by popular demand

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index f83a050b35ae8b54dca158a58ab0cbf10ad34875..3bf2147787acc5cc0473a3e78c2fe47f36c4a6bb 100644 (file)
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -209,7 +209,7 @@ send them as replies to either an additional "cover letter" message
 (see below), the first patch, or the respective preceding patch.
 
 If your log message (including your name on the
-Signed-off-by line) is not writable in ASCII, make sure that
+`Signed-off-by` trailer) is not writable in ASCII, make sure that
 you send off a message in the correct encoding.
 
 WARNING: Be wary of your MUAs word-wrap
@@ -229,7 +229,7 @@ previously sent.
 The `git format-patch` command follows the best current practice to
 format the body of an e-mail message.  At the beginning of the
 patch should come your commit message, ending with the
-Signed-off-by: lines, and a line that consists of three dashes,
+`Signed-off-by` trailers, and a line that consists of three dashes,
 followed by the diffstat information and the patch itself.  If
 you are forwarding a patch from somebody else, optionally, at
 the beginning of the e-mail message just before the commit
@@ -298,7 +298,7 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
 patch.
 
 [[sign-off]]
-=== Certify your work by adding your "Signed-off-by: " line
+=== Certify your work by adding your `Signed-off-by` trailer
 
 To improve tracking of who did what, we ask you to certify that you
 wrote the patch or have the right to pass it on under the same license
@@ -345,7 +345,7 @@ this:
 This line can be added by Git if you run the git-commit command with
 the -s option.
 
-Notice that you can place your own Signed-off-by: line when
+Notice that you can place your own `Signed-off-by` trailer when
 forwarding somebody else's patch with the above rules for
 D-C-O.  Indeed you are encouraged to do so.  Do not forget to
 place an in-body "From: " line at the beginning to properly attribute
@@ -357,7 +357,7 @@ your patch differs from project to project, so it may be different
 from that of the project you are accustomed to.
 
 [[real-name]]
-Also notice that a real name is used in the Signed-off-by: line. Please
+Also notice that a real name is used in the `Signed-off-by` trailer. Please
 don't hide your real name.
 
 [[commit-trailers]]

diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index c2efd8758a5841d40b41003edb7713089b0650a3..851bf410a3bba8ff41e78993b9642d7a23d1652a 100644 (file)
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -79,7 +79,7 @@ format.thread::
 
 format.signOff::
        A boolean value which lets you enable the `-s/--signoff` option of
-       format-patch by default. *Note:* Adding the Signed-off-by: line to a
+       format-patch by default. *Note:* Adding the `Signed-off-by` trailer to a
        patch should be a conscious act and means that you certify you have
        the rights to submit this work under the same open source license.
        Please see the 'SubmittingPatches' document for further discussion.

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 38c0852139c17077aacb6bc43fcf8102cc6570f4..06bc063542f3044cc9fe7ced6ecd4922d2e209e2 100644 (file)
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -33,7 +33,7 @@ OPTIONS
 
 -s::
 --signoff::
-       Add a `Signed-off-by:` line to the commit message, using
+       Add a `Signed-off-by` trailer to the commit message, using
        the committer identity of yourself.
        See the signoff option in linkgit:git-commit[1] for more information.
 

diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 75feeef08a0e64ac3f6bfc35290e92984c1a1580..5d750314b299cc7157034b9bffd6a5aa3afe51d4 100644 (file)
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -104,7 +104,7 @@ effect to your index in a row.
 
 -s::
 --signoff::
-       Add Signed-off-by line at the end of the commit message.
+       Add a `Signed-off-by` trailer at the end of the commit message.
        See the signoff option in linkgit:git-commit[1] for more information.
 
 -S[<keyid>]::

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 0f81d0437bb65bd0ee68ef63edf7bb48d9ea87a6..bf1bb40f6303fab2a8362af493b1839af21471f2 100644 (file)
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -119,7 +119,7 @@ include::diff-options.txt[]
 
 -s::
 --signoff::
-       Add `Signed-off-by:` line to the commit message, using
+       Add a `Signed-off-by` trailer to the commit message, using
        the committer identity of yourself.
        See the signoff option in linkgit:git-commit[1] for more information.
 

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 38e15488f651718bf220453504a39fb8ef0800f7..a0487b5cc58816ac8c4ec700e56a5d116fd61824 100644 (file)
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -496,7 +496,7 @@ See also INCOMPATIBLE OPTIONS below.
 See also INCOMPATIBLE OPTIONS below.
 
 --signoff::
-       Add a Signed-off-by: trailer to all the rebased commits. Note
+       Add a `Signed-off-by` trailer to all the rebased commits. Note
        that if `--interactive` is given then only commits marked to be
        picked, edited or reworded will have the trailer added.
 +

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 044276e9da62af44af9a8d897df0dd536556610b..bb92a4a4516d2a93a6e85facb0831aabc1be126c 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -99,7 +99,7 @@ effect to your index in a row.
 
 -s::
 --signoff::
-       Add Signed-off-by line at the end of the commit message.
+       Add a `Signed-off-by` trailer at the end of the commit message.
        See the signoff option in linkgit:git-commit[1] for more information.
 
 --strategy=<strategy>::

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 0a69810147e451d7cac290020f009631b1da9e46..b7bbbeadef6df43a9497cbbfad1f8cbf8213cd6f 100644 (file)
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -313,7 +313,7 @@ Automating
        the value of `sendemail.identity`.
 
 --[no-]signed-off-by-cc::
-       If this is set, add emails found in Signed-off-by: or Cc: lines to the
+       If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
        cc list. Default is the value of `sendemail.signedoffbycc` configuration
        value; if that is unspecified, default to --signed-off-by-cc.
 
@@ -340,7 +340,7 @@ Automating
   except for self (use 'self' for that).
 - 'bodycc' will avoid including anyone mentioned in Cc lines in the
   patch body (commit message) except for self (use 'self' for that).
-- 'sob' will avoid including anyone mentioned in Signed-off-by lines except
+- 'sob' will avoid including anyone mentioned in the Signed-off-by trailers except
   for self (use 'self' for that).
 - 'misc-by' will avoid including anyone mentioned in Acked-by,
   Reviewed-by, Tested-by and other "-by" lines in the patch body,

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 6624a14fbd70992a0bfbba99b73cc2110208c421..67b143cc81ea9534722a082fdfbc016081621411 100644 (file)
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -701,7 +701,7 @@ creating the branch or tag.
 
 --use-log-author::
        When retrieving svn commits into Git (as part of 'fetch', 'rebase', or
-       'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
+       'dcommit' operations), look for the first `From:` line or `Signed-off-by` trailer
        in the log message and use that as the author string.
 +
 [verse]
@@ -710,7 +710,7 @@ config key: svn.useLogAuthor
 --add-author-from::
        When committing to svn from Git (as part of 'set-tree' or 'dcommit'
        operations), if the existing log message doesn't already have a
-       `From:` or `Signed-off-by:` line, append a `From:` line based on the
+       `From:` or `Signed-off-by` trailer, append a `From:` line based on the
        Git commit's author string.  If you use this, then `--use-log-author`
        will retrieve a valid author string for all commits.
 +

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 6e461ace6e6434789cee58fb95542e4fc1653d78..4e097dc4e9de8ee0c3a6029914e3816f0f32b31c 100644 (file)
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -164,7 +164,7 @@ can also be used to refuse the commit after inspecting the message
 file.
 
 The default 'commit-msg' hook, when enabled, detects duplicate
-"Signed-off-by" lines, and aborts the commit if one is found.
+`Signed-off-by` trailers, and aborts the commit if one is found.
 
 post-commit
 ~~~~~~~~~~~

diff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt
index fbff8dd5be25afd80bd3454d139834b69ea91504..12aa2333e46b02aaf86106705bac722ceeec09f8 100644 (file)
--- a/Documentation/signoff-option.txt
+++ b/Documentation/signoff-option.txt
@@ -3,7 +3,7 @@ ifdef::git-commit[]
 endif::git-commit[]
 --signoff::
 --no-signoff::
-       Add a Signed-off-by trailer by the committer at the end of the commit
+       Add a `Signed-off-by` trailer by the committer at the end of the commit
        log message.  The meaning of a signoff depends on the project
        to which you're committing.  For example, it may certify that
        the committer has the rights to submit the work under the

diff --git a/builtin/am.c b/builtin/am.c
index 2c7673f74e22761337b67515632d547000049979..26f53cdc09e8edabc3bbf6b7795058ddcb34768d 100644 (file)
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -2237,7 +2237,7 @@ int cmd_am(int argc, const char **argv, const char *prefix)
                        N_("allow fall back on 3way merging if needed")),
                OPT__QUIET(&state.quiet, N_("be quiet")),
                OPT_SET_INT('s', "signoff", &state.signoff,
-                       N_("add a Signed-off-by line to the commit message"),
+                       N_("add a Signed-off-by trailer to the commit message"),
                        SIGNOFF_EXPLICIT),
                OPT_BOOL('u', "utf8", &state.utf8,
                        N_("recode into utf8 (default)")),

diff --git a/builtin/commit.c b/builtin/commit.c
index 1dfd799ec5185928f327d2cdd3156b41d6c0199e..505fe60956db385d94aa7fd14e016a3dfeb9345c 100644 (file)
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -1507,7 +1507,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
                OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
                OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
                OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
-               OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
+               OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
                OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
                OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
                OPT_CLEANUP(&cleanup_arg),

diff --git a/builtin/log.c b/builtin/log.c
index 0a7ed4bef92b91e75bd8c580544bdd81caea9102..9f939e6cdf2f1048177bed0a5e7ab174f4020ded 100644 (file)
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1738,7 +1738,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
                OPT_CALLBACK_F('N', "no-numbered", &numbered, NULL,
                            N_("use [PATCH] even with multiple patches"),
                            PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback),
-               OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
+               OPT_BOOL('s', "signoff", &do_signoff, N_("add a Signed-off-by trailer")),
                OPT_BOOL(0, "stdout", &use_stdout,
                            N_("print patches to standard out")),
                OPT_BOOL(0, "cover-letter", &cover_letter,

diff --git a/builtin/merge.c b/builtin/merge.c
index 9d5359edc2f72799e1bf517db5f26c5f29aff81f..4c133402a62332768b7a7136ded5ea7f4def93fe 100644 (file)
--- a/builtin/merge.c
+++ b/builtin/merge.c
@@ -289,7 +289,7 @@ static struct option builtin_merge_options[] = {
          N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
        OPT_AUTOSTASH(&autostash),
        OPT_BOOL(0, "overwrite-ignore", &overwrite_ignore, N_("update ignored files (default)")),
-       OPT_BOOL(0, "signoff", &signoff, N_("add Signed-off-by:")),
+       OPT_BOOL(0, "signoff", &signoff, N_("add a Signed-off-by trailer")),
        OPT_BOOL(0, "no-verify", &no_verify, N_("bypass pre-merge-commit and commit-msg hooks")),
        OPT_END()
 };

diff --git a/builtin/pull.c b/builtin/pull.c
index 425950f46973d3949e24cbc1cf8cf74e97eeb417..17aa63cd35aa4425a8832750ecc334e5184ac60d 100644 (file)
--- a/builtin/pull.c
+++ b/builtin/pull.c
@@ -142,7 +142,7 @@ static struct option pull_options[] = {
                N_("add (at most <n>) entries from shortlog to merge commit message"),
                PARSE_OPT_OPTARG),
        OPT_PASSTHRU(0, "signoff", &opt_signoff, NULL,
-               N_("add Signed-off-by:"),
+               N_("add a Signed-off-by trailer"),
                PARSE_OPT_OPTARG),
        OPT_PASSTHRU(0, "squash", &opt_squash, NULL,
                N_("create a single commit instead of doing a merge"),

diff --git a/builtin/rebase.c b/builtin/rebase.c
index eeca53382f793356e5f4a0114de062fb3926e236..7b65525301c04a0b5f3f20ac8989c9683f2b8d5b 100644 (file)
--- a/builtin/rebase.c
+++ b/builtin/rebase.c
@@ -1324,7 +1324,7 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
                        N_("do not show diffstat of what changed upstream"),
                        PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
                OPT_BOOL(0, "signoff", &options.signoff,
-                        N_("add a Signed-off-by: line to each commit")),
+                        N_("add a Signed-off-by trailer to each commit")),
                OPT_BOOL(0, "committer-date-is-author-date",
                         &options.committer_date_is_author_date,
                         N_("make committer date match author date")),

diff --git a/builtin/revert.c b/builtin/revert.c
index f61cc5d82cf2697583b5851893ba4076f96643a5..da8997dc861ce37362372659e3eb59dcc694b9d4 100644 (file)
--- a/builtin/revert.c
+++ b/builtin/revert.c
@@ -107,7 +107,7 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
                OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
                OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
                OPT_NOOP_NOARG('r', NULL),
-               OPT_BOOL('s', "signoff", &opts->signoff, N_("add Signed-off-by:")),
+               OPT_BOOL('s', "signoff", &opts->signoff, N_("add a Signed-off-by trailer")),
                OPT_CALLBACK('m', "mainline", opts, N_("parent-number"),
                             N_("select mainline parent"), option_parse_m),
                OPT_RERERE_AUTOUPDATE(&opts->allow_rerere_auto),

diff --git a/commit.c b/commit.c
index f53429c0ac34d933a06f6051cd6b5e519408e4be..fe1fa3dc41fe787883752671e5954b75616fe9ac 100644 (file)
--- a/commit.c
+++ b/commit.c
@@ -1586,7 +1586,7 @@ const char *find_commit_header(const char *msg, const char *key, size_t *out_len
 
 /*
  * Inspect the given string and determine the true "end" of the log message, in
- * order to find where to put a new Signed-off-by: line.  Ignored are
+ * order to find where to put a new Signed-off-by trailer.  Ignored are
  * trailing comment lines and blank lines.  To support "git commit -s
  * --amend" on an existing commit, we also ignore "Conflicts:".  To
  * support "git commit -v", we truncate at cut lines.