# [PATCH] Expand documentation describing --signoff 2 messages from 2016-01-05 to 2016-01-05. Participants: David A. Wheeler, Junio C Hamano. Thread: https://gitlist.dev/t/41132 ## David A. Wheeler, 2016-01-05 19:20 Subject: [PATCH] Expand documentation describing --signoff Message-ID: URL: https://gitlist.dev/e/E1aGX9e-0002m1-55%40rmm6prod02.runbox.com ``` Modify various document (man page) files to explain in more detail what --signoff means. This was inspired by https://lwn.net/Articles/669976/ where paulj noted, "adding [the] '-s' argument to [a] git commit doesn't really mean you have even heard of the DCO...". Extending git's documentation will make it easier to argue that developers understood --signoff when they use it. Signed-off-by: David A. Wheeler --- Documentation/git-am.txt | 1 + Documentation/git-cherry-pick.txt | 1 + Documentation/git-commit.txt | 6 +++++- Documentation/git-format-patch.txt | 1 + Documentation/git-revert.txt | 1 + 5 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 452c1fe..13cdd7f 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -35,6 +35,7 @@ OPTIONS --signoff:: Add a `Signed-off-by:` line to the commit message, using the committer identity of yourself. + See the signoff option in linkgit:git-commit[1] for more information. -k:: --keep:: diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 77da29a..6154e57 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -100,6 +100,7 @@ effect to your index in a row. -s:: --signoff:: Add Signed-off-by line at the end of the commit message. + See the signoff option in linkgit:git-commit[1] for more information. -S[]:: --gpg-sign[=]:: diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 7f34a5b..9ec6b3c 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -154,7 +154,11 @@ OPTIONS -s:: --signoff:: Add Signed-off-by line by the committer at the end of the commit - log message. + log message. The meaning of a signoff depends on the project, + but it typically certifies that committer has + the rights to submit this work under the same license and + agrees to a Developer Certificate of Origin + (see http://developercertificate.org/ for more information). -n:: --no-verify:: diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index e3cdaeb..b149e09 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -109,6 +109,7 @@ include::diff-options.txt[] --signoff:: Add `Signed-off-by:` line to the commit message, using the committer identity of yourself. + See the signoff option in linkgit:git-commit[1] for more information. --stdout:: Print all commits to the standard output in mbox format, diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index b15139f..573616a 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -89,6 +89,7 @@ effect to your index in a row. -s:: --signoff:: Add Signed-off-by line at the end of the commit message. + See the signoff option in linkgit:git-commit[1] for more information. --strategy=:: Use the given merge strategy. Should only be used once. -- 2.5.3 ``` ## Junio C Hamano, 2016-01-05 23:02 Subject: Re: [PATCH] Expand documentation describing --signoff Message-ID: URL: https://gitlist.dev/e/xmqqa8ojiqa8.fsf%40gitster.mtv.corp.google.com In-Reply-To: ``` "David A. Wheeler" writes: > Modify various document (man page) files to explain > in more detail what --signoff means. > > This was inspired by https://lwn.net/Articles/669976/ where > paulj noted, "adding [the] '-s' argument to [a] git commit > doesn't really mean you have even heard of the DCO...". > Extending git's documentation will make it easier to argue > that developers understood --signoff when they use it. > > Signed-off-by: David A. Wheeler > --- Looks sensible, striking the balance between the need by the projects that do adopt DCO to be specific, and the need by the others to allow other uses of "-s". Will queue; thanks. > Documentation/git-am.txt | 1 + > Documentation/git-cherry-pick.txt | 1 + > Documentation/git-commit.txt | 6 +++++- > Documentation/git-format-patch.txt | 1 + > Documentation/git-revert.txt | 1 + > 5 files changed, 9 insertions(+), 1 deletion(-) > > diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt > index 452c1fe..13cdd7f 100644 > --- a/Documentation/git-am.txt > +++ b/Documentation/git-am.txt > @@ -35,6 +35,7 @@ OPTIONS > --signoff:: > Add a `Signed-off-by:` line to the commit message, using > the committer identity of yourself. > + See the signoff option in linkgit:git-commit[1] for more information. > > -k:: > --keep:: > diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt > index 77da29a..6154e57 100644 > --- a/Documentation/git-cherry-pick.txt > +++ b/Documentation/git-cherry-pick.txt > @@ -100,6 +100,7 @@ effect to your index in a row. > -s:: > --signoff:: > Add Signed-off-by line at the end of the commit message. > + See the signoff option in linkgit:git-commit[1] for more information. > > -S[]:: > --gpg-sign[=]:: > diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt > index 7f34a5b..9ec6b3c 100644 > --- a/Documentation/git-commit.txt > +++ b/Documentation/git-commit.txt > @@ -154,7 +154,11 @@ OPTIONS > -s:: > --signoff:: > Add Signed-off-by line by the committer at the end of the commit > - log message. > + log message. The meaning of a signoff depends on the project, > + but it typically certifies that committer has > + the rights to submit this work under the same license and > + agrees to a Developer Certificate of Origin > + (see http://developercertificate.org/ for more information). > > -n:: > --no-verify:: > diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt > index e3cdaeb..b149e09 100644 > --- a/Documentation/git-format-patch.txt > +++ b/Documentation/git-format-patch.txt > @@ -109,6 +109,7 @@ include::diff-options.txt[] > --signoff:: > Add `Signed-off-by:` line to the commit message, using > the committer identity of yourself. > + See the signoff option in linkgit:git-commit[1] for more information. > > --stdout:: > Print all commits to the standard output in mbox format, > diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt > index b15139f..573616a 100644 > --- a/Documentation/git-revert.txt > +++ b/Documentation/git-revert.txt > @@ -89,6 +89,7 @@ effect to your index in a row. > -s:: > --signoff:: > Add Signed-off-by line at the end of the commit message. > + See the signoff option in linkgit:git-commit[1] for more information. > > --strategy=:: > Use the given merge strategy. Should only be used once. ```