Skip to content

Commit b2c150d

Browse files
david-a-wheelergitster
authored andcommitted
Expand documentation describing --signoff
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 <dwheeler@dwheeler.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 833e482 commit b2c150d

File tree

5 files changed

+9
-1
lines changed

5 files changed

+9
-1
lines changed

Documentation/git-am.txt

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ OPTIONS
3535
--signoff::
3636
Add a `Signed-off-by:` line to the commit message, using
3737
the committer identity of yourself.
38+
See the signoff option in linkgit:git-commit[1] for more information.
3839

3940
-k::
4041
--keep::

Documentation/git-cherry-pick.txt

+1
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ effect to your index in a row.
100100
-s::
101101
--signoff::
102102
Add Signed-off-by line at the end of the commit message.
103+
See the signoff option in linkgit:git-commit[1] for more information.
103104

104105
-S[<keyid>]::
105106
--gpg-sign[=<keyid>]::

Documentation/git-commit.txt

+5-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,11 @@ OPTIONS
154154
-s::
155155
--signoff::
156156
Add Signed-off-by line by the committer at the end of the commit
157-
log message.
157+
log message. The meaning of a signoff depends on the project,
158+
but it typically certifies that committer has
159+
the rights to submit this work under the same license and
160+
agrees to a Developer Certificate of Origin
161+
(see http://developercertificate.org/ for more information).
158162

159163
-n::
160164
--no-verify::

Documentation/git-format-patch.txt

+1
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ include::diff-options.txt[]
109109
--signoff::
110110
Add `Signed-off-by:` line to the commit message, using
111111
the committer identity of yourself.
112+
See the signoff option in linkgit:git-commit[1] for more information.
112113

113114
--stdout::
114115
Print all commits to the standard output in mbox format,

Documentation/git-revert.txt

+1
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ effect to your index in a row.
8989
-s::
9090
--signoff::
9191
Add Signed-off-by line at the end of the commit message.
92+
See the signoff option in linkgit:git-commit[1] for more information.
9293

9394
--strategy=<strategy>::
9495
Use the given merge strategy. Should only be used once.

0 commit comments

Comments
 (0)