Git Mailing List Archive on lore.kernel.org
 help / color / Atom feed
From: "Bradley M. Kuhn" <bkuhn@sfconservancy.org>
To: git@vger.kernel.org
Cc: Jeff King <peff@peff.net>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v2 0/3] clarify and expand description of --signoff & related fixes
Date: Mon, 19 Oct 2020 14:25:41 -0700
Message-ID: <cover.1603142543.git.bkuhn@sfconservancy.org> (raw)
In-Reply-To: <xmqqmu0it6ls.fsf@gitster.c.googlers.com>

Jeff wrote last week:
>>> You said "squashing", but I'd suggest keeping it as its own patch on top
>>> of Bradley's.
Junio replied last week:
>> OK, let's do so.
Theodore Ts'o wrote today at 08:53 (PDT):
>>>> I pointed out a missing article ("a") in the line *above* ... It's a
>>>> minor nit, and it's unrelated to his proposed change.
Junio C Hamano replied today at 11:26 (PDT):
> In any case, an updated version that ended up
> being a 3-patch series is now on the table.  I think they are in good
> shape to be merged down.

Herein is (I believe) the three-patch series that Junio references.  The
middle patch didn't exist yet because Ted just pointed out the typo and
didn't have a patch, but I've done the typo fix and credited Ted on that in
the commit.

However, the middle commit ([PATCH v2 2/3]) needs some review.  I ended up
down the rabbit hole of "what is the consistent way in which the Git
documentation refers to Signed-off-by?" and I found many inconsistencies.
I've normalized around a style convention described in that patch's commit
message.

Meanwhile, I also note that SubmittingPatches now calls these "trailers"
rather than "lines", so maybe we should be using the word "trailer" rather
than "line" consistently in the other documentation?  If folks think that
should be done, I can redo this patchset to go that route.

Alternatively, if anyone has any strong opinions on the normalization to:
  (a|the) `Signed-off-by:` line
in documentation formatting when referring to Signed-off-by, please say so.

Thanks everyone for your comments and help on this!

I also added these, as Jeff King wrote about at 17:46 (PDT) on Thursday:
>>> To be clear, it's...
>>>  Signed-off-by: Jeff King <peff@peff.net>
>>> as far as any words I contributed.

Added.

>>> I probably would've kept "clarify" in the title as lowercase.

Fixed.

>>>>> diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
>>>>> index 80d4831662..c9df9cc0f4 100644
>>>>> --- a/Documentation/merge-options.txt
>>>>> +++ b/Documentation/merge-options.txt
>>>>> [...]
>>>>> +	leadership of the project to which you're contributing to understand
>>>>> +	 how the signoffs are used in that project.

>>> Extra leading space on this final line.

Also fixed.

Bradley M. Kuhn (2):
  Documentation: clarify and expand description of --signoff
  Documentation: stylistically normalize references to Signed-off-by:

Junio C Hamano (1):
  SubmittingPatches: clarify DCO is our --signoff rule

 Documentation/MyFirstContribution.txt |  2 +-
 Documentation/SubmittingPatches       | 35 +++++++++++++++------------
 Documentation/git-cherry-pick.txt     |  2 +-
 Documentation/git-commit.txt          | 15 +++++++-----
 Documentation/git-format-patch.txt    |  2 +-
 Documentation/git-rebase.txt          |  2 +-
 Documentation/git-revert.txt          |  2 +-
 Documentation/git-send-email.txt      |  4 +--
 Documentation/githooks.txt            |  2 +-
 Documentation/merge-options.txt       | 17 +++++++------
 builtin/am.c                          |  2 +-
 builtin/commit.c                      |  2 +-
 builtin/log.c                         |  2 +-
 builtin/merge.c                       |  2 +-
 builtin/pull.c                        |  2 +-
 builtin/revert.c                      |  2 +-
 16 files changed, 52 insertions(+), 43 deletions(-)

-- 
Bradley M. Kuhn - he/him
Policy Fellow & Hacker-in-Residence at Software Freedom Conservancy
========================================================================
Become a Conservancy Supporter today: https://sfconservancy.org/supporter


  reply index

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-15 21:59 [PATCH 0/1] Clarify and expand description of --signoff Bradley M. Kuhn
2020-10-15 21:59 ` [PATCH 1/1] Documentation: " Bradley M. Kuhn
2020-10-16  0:46   ` Jeff King
2020-10-18 15:13   ` Theodore Y. Ts'o
2020-10-16  1:49 ` [PATCH 0/1] " Philippe Blain
2020-10-16  1:54   ` Junio C Hamano
2020-10-16  1:59     ` Jeff King
2020-10-16  2:30       ` Junio C Hamano
2020-10-16 19:53         ` Junio C Hamano
2020-10-16 20:11           ` Jeff King
2020-10-17  3:00             ` Bradley M. Kuhn
2020-10-18 19:08             ` Junio C Hamano
2020-10-19 15:53               ` Theodore Y. Ts'o
2020-10-19 18:26                 ` Junio C Hamano
2020-10-19 21:25                   ` Bradley M. Kuhn [this message]
2020-10-19 21:25                     ` [PATCH v2 1/3] Documentation: clarify " Bradley M. Kuhn
2020-10-19 21:25                     ` [PATCH v2 2/3] Documentation: stylistically normalize references to Signed-off-by: Bradley M. Kuhn
2020-10-19 22:02                       ` Taylor Blau
2020-10-19 22:17                         ` Junio C Hamano
2020-10-20  2:31                           ` Taylor Blau
2020-10-20  1:03                         ` [PATCH v3 0/4] clarify meaning of --signoff & related doc improvements in describing Signed-off-by Bradley M. Kuhn
2020-10-20  1:03                           ` [PATCH v3 1/4] doc: preparatory clean-up of description on the sign-off option Bradley M. Kuhn
2020-10-20  1:03                           ` [PATCH v3 2/4] Documentation: clarify and expand description of --signoff Bradley M. Kuhn
2020-10-20 21:44                             ` Bradley M. Kuhn
2020-10-20 21:48                               ` Taylor Blau
2020-10-20  1:03                           ` [PATCH v3 3/4] SubmittingPatches: clarify DCO is our --signoff rule Bradley M. Kuhn
2020-10-20  1:03                           ` [PATCH v3 4/4] Documentation: stylistically normalize references to Signed-off-by: Bradley M. Kuhn
2020-10-20 18:52                             ` Junio C Hamano
2020-10-20 21:33                               ` Bradley M. Kuhn
2020-10-20  2:34                           ` [PATCH v3 0/4] clarify meaning of --signoff & related doc improvements in describing Signed-off-by Taylor Blau
2020-10-20 21:28                             ` Bradley M. Kuhn
2020-10-20 21:48                               ` Taylor Blau
2020-10-20 22:06                               ` Junio C Hamano
2020-10-20 23:02                                 ` Bradley M. Kuhn
2020-10-19 21:25                     ` [PATCH v2 3/3] SubmittingPatches: clarify DCO is our --signoff rule Bradley M. Kuhn
2020-10-18 19:49 [PATCH v2 0/3] Claryfing the meaning of the sign-off Junio C Hamano
2020-10-18 19:49 ` [PATCH v2 1/3] doc: preparatory clean-up of description on the sign-off option Junio C Hamano
2020-10-18 19:49 ` [PATCH v2 2/3] Documentation: clarify and expand description of --signoff Junio C Hamano
2020-10-18 19:49 ` [PATCH v2 3/3] SubmittingPatches: clarify DCO is our --signoff rule Junio C Hamano
2020-10-18 23:31 ` [PATCH v2 0/3] Claryfing the meaning of the sign-off Taylor Blau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1603142543.git.bkuhn@sfconservancy.org \
    --to=bkuhn@sfconservancy.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Git Mailing List Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/git/0 git/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 git git/ https://lore.kernel.org/git \
		git@vger.kernel.org
	public-inbox-index git

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.git


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git