summaryrefslogtreecommitdiffstats
path: root/Documentation/process/submitting-patches.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: Clarify the usage and sign-off requirements for Co-developed-bySean Christopherson2019-03-251-5/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 direction 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. The use of "original author" has also led to confusion as many patches don't have just one "original" author, e.g. when multiple developers are involved from the genesis of the patch. Remove all usage of "original" and instead call out that Co-developed-by is simply a way to provide attribution in addition to the From tag, i.e. neither tag is intended to imply anything with regard to who did what. Provide examples to (hopefully) eliminate any ambiguity. Cc: Tobin C. Harding <me@tobin.cc> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Jani Nikula <jani.nikula@linux.intel.com> Cc: Jorge Ramirez-Ortiz <jorge.ramirez-ortiz@linaro.org> Cc: Jonathan Cameron <jic23@kernel.org> Cc: Joe Perches <joe@perches.com> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Niklas Cassel <niklas.cassel@linaro.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: remove spaces from shell variable assignmentTom Levy2019-03-251-3/+3
| | | | | | | | | | | | | | The instructions for generating patches are given as shell commands with variables as placeholders. They use the syntax "SRCTREE= linux", which is wrong for the Bourne shell family (it runs the command "linux" with the variable "SRCTREE" set to the empty string). Remove the spaces to avoid confusion. This breaks the pretty alignment but helps new contributors who try to run the commands as written. Signed-off-by: Tom Levy <tomlevy93@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Explicitly state that the 'Fixes:' tag shouldn't split linesSean Christopherson2019-02-221-2/+4
| | | | | | | | | | | | | | | | | | | ...and use a commit with an obnoxiously long summary in the example to make it abundantly clear that keeping the tag on a single line takes priority over wrapping at 75 columns. Without the explicit exemption, one might assume splitting the tag is acceptable, even encouraged, e.g. due to being conditioned by checkpatch's line length warning. Per Stephen's scripts[1] and implied by commit bf4daf12a9fb ("checkpatch: avoid some commit message long line warnings"), splitting the 'Fixes:' tag across multiple lines is a no-no, presumably because parsing multi- line tags is unnecessarily painful. [1] https://lkml.kernel.org/r/20190216183433.71b7cfa7@canb.auug.org.au Cc: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: fix Co-Developed-by docsJorge Ramirez-Ortiz2019-01-041-2/+2
| | | | | | | | | | | | | | | | The accepted terminology will be Co-developed-by therefore lose the capital letter from now on. Link: http://lkml.kernel.org/r/1544808928-20002-2-git-send-email-jorge.ramirez-ortiz@linaro.org Signed-off-by: Jorge Ramirez-Ortiz <jorge.ramirez-ortiz@linaro.org> Acked-by: Himanshu Jha <himanshujha199640@gmail.com> Cc: Jonathan Cameron <jic23@kernel.org> Cc: Joe Perches <joe@perches.com> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Niklas Cassel <niklas.cassel@linaro.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* docs: Add rest label the_canonical_patch_formatTobin C. Harding2018-07-261-0/+1
| | | | | | | | | | | In preparation to convert Documentation/network/netdev-FAQ.rst to restructured text format. We would like to be able to reference 'the canonical patch format' section. Add rest label: 'the_canonical_patch_format'. Signed-off-by: Tobin C. Harding <me@tobin.cc> Signed-off-by: David S. Miller <davem@davemloft.net>
* Docs: tell maintainers to put [GIT PULL] in their subject linesMatthew Wilcox2018-04-161-1/+1
| | | | | | | | | It seems that Linus looks for [GIT PULL] in subject lines to ensure that pull requests don't get buried in the noise during merge windows. Update the docs to reflect that. [jc: From an impromptu post from willy, thus no SOB] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: add Co-Developed-by docsTobin C. Harding2018-03-071-2/+7
| | | | | | | | | | | | When Co-Developed-by tag was added, docs were only added to Documention/process/5.Posting.rst and were not added to Documention/process/submitting-patches.rst Add documentation to Documention/process/submitting-patches.rst Signed-off-by: Tobin C. Harding <me@tobin.cc> [jc: tweaked commas in the subheading] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/process: fix the canonical patch format descriptionJunio C Hamano2017-09-261-4/+4
| | | | | | | | | There shouldn't be a blank line at the beginning, if there is no optional in-body "From" line. There must be a blank line between the body of the explanation and the beginning of the S-o-b lines. Signed-off-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: submitting-patches - change non-ascii character to asciiFrank Rowand2017-07-231-1/+1
| | | | | | | | Documentation/process/submitting-patches.rst contains a non-ascii character. Change it to the ascii equivalent. Signed-off-by: Frank Rowand <frank.rowand@sony.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Tweak submitting-patches.rst formattingJonathan Corbet2016-10-271-10/+6
| | | | | | | | | The main goal here was to get the subsections to show in the TOC as they do for all the other documents. Also call out the DCO in the section title since it's important. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: fix locations of several documents that got movedMauro Carvalho Chehab2016-10-241-7/+7
| | | | | | | | The previous patch renamed several files that are cross-referenced along the Kernel documentation. Adjust the links to point to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: add documents to development-processMauro Carvalho Chehab2016-10-241-0/+840
Add several documents to the development-process ReST book. As we don't want renames, use symlinks instead, keeping those documents on their original place. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>