From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0615DC43381 for ; Thu, 21 Mar 2019 20:01:08 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id C7838218A5 for ; Thu, 21 Mar 2019 20:01:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728759AbfCUUBG (ORCPT ); Thu, 21 Mar 2019 16:01:06 -0400 Received: from mga01.intel.com ([192.55.52.88]:8744 "EHLO mga01.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727881AbfCUUBG (ORCPT ); Thu, 21 Mar 2019 16:01:06 -0400 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Mar 2019 13:01:05 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,254,1549958400"; d="scan'208";a="284728816" Received: from sjchrist-coffee.jf.intel.com ([10.54.74.181]) by orsmga004.jf.intel.com with ESMTP; 21 Mar 2019 13:01:05 -0700 From: Sean Christopherson To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Thomas Gleixner , Jani Nikula , Jorge Ramirez-Ortiz , Jonathan Cameron , Joe Perches , Greg Kroah-Hartman , Niklas Cassel Subject: [PATCH v3] docs: Clarify the usage and sign-off requirements for Co-developed-by Date: Thu, 21 Mar 2019 13:01:03 -0700 Message-Id: <20190321200103.9333-1-sean.j.christopherson@intel.com> X-Mailer: git-send-email 2.21.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The documentation for Co-developed-by is a bit light on details, e.g. it doesn't explicitly state that: - Multiple Co-developed-by tags are perfectly acceptable - Co-developed-by and Signed-off-by must be paired together - SOB ordering should still follow standard sign-off procedure Lack of explicit direciton has resulted in developers taking a variety of approaches, often lacking any intent whatsoever, e.g. scattering SOBs willy-nilly, collecting them all at the end or the beginning, etc... Tweak the wording to make it clear that multiple co-authors are allowed, and document the expectation that standard sign-off procedures are to be followed. Provide examples to (hopefully) eliminate any ambiguity. Cc: Thomas Gleixner Cc: Jani Nikula Cc: Jorge Ramirez-Ortiz Cc: Jonathan Cameron Cc: Joe Perches Cc: Greg Kroah-Hartman Cc: Niklas Cassel Cc: Jonathan Corbet Signed-off-by: Sean Christopherson --- v1: https://lkml.kernel.org/r/20190320151140.32432-1-sean.j.christopherson@intel.com v2: https://lkml.kernel.org/r/20190321184316.8525-1-sean.j.christopherson@intel.com Rewrite the blurb to state standard sign-off procedure should be followed as opposed to dictating the original author's SOB be last. v3: Update a similar blurb in Documentation/process/5.Posting.rst Documentation/process/5.Posting.rst | 8 +++---- Documentation/process/submitting-patches.rst | 24 +++++++++++++++++--- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst index 4213e580f273..c8cac58f0f93 100644 --- a/Documentation/process/5.Posting.rst +++ b/Documentation/process/5.Posting.rst @@ -216,10 +216,10 @@ The tags in common use are: which can be found in :ref:`Documentation/process/submitting-patches.rst ` Code without a proper signoff cannot be merged into the mainline. - - Co-developed-by: states that the patch was also created by another developer - along with the original author. This is useful at times when multiple - people work on a single patch. Note, this person also needs to have a - Signed-off-by: line in the patch as well. + - Co-developed-by: states that the patch was co-created by other developer(s) + along with the original author. Every Co-developed-by: must be accompanied + by a Signed-off-by: of the co-author. Details and examples can be found in + :ref:`Documentation/process/submitting-patches.rst `. - Acked-by: indicates an agreement by another developer (often a maintainer of the relevant code) that the patch is appropriate for diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst index be7d1829c3af..a7a9da68a384 100644 --- a/Documentation/process/submitting-patches.rst +++ b/Documentation/process/submitting-patches.rst @@ -545,10 +545,28 @@ person it names - but it should indicate that this person was copied on the patch. This tag documents that potentially interested parties have been included in the discussion. -A Co-developed-by: states that the patch was also created by another developer +A Co-developed-by: states that the patch was co-created by other developer(s) along with the original author. This is useful at times when multiple people -work on a single patch. Note, this person also needs to have a Signed-off-by: -line in the patch as well. +work on a single patch. Every Co-developed-by: must be immediately followed by +a Signed-off-by: of the co-author. Standard sign-off procedure applies, i.e. +the ordering of Co-developed-by:/Signed-off-by: pairs should reflect the +chronological history of the patch insofar as possible. Notably, the last +Signed-off-by: must always be that of the developer submitting the patch, +regardless of whether they are the original author or a co-author. + +Example of a patch with multiple co-authors, submitted by the original author:: + + Co-developed-by: First Co-Author + Signed-off-by: First Co-Author + Co-developed-by: Second Co-Author + Signed-off-by: Second Co-Author + Signed-off-by: Original Author + +Example of a patch submitted by a co-author:: + + Signed-off-by: Original Author + Co-developed-by: Submitting Co-Author + Signed-off-by: Submitting Co-Author 13) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: -- 2.21.0