From 7e0befc8e48a49e2ddf86bbd861027b14ea5a53d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Hinderer?=
 <Sebastien.Hinderer@ens-lyon.org>
Date: Wed, 8 Jul 2015 21:10:18 +0200
Subject: [PATCH] SubmittingPatches: fix typo
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-Type: text/plain; charset="utf-8"
Signed-off-by: NSébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

I misunderstood this section as simply asking me to add an email Cc, and
was unaware of the existence of Documentation/stable_kernel_rules.txt.
Hopefully this clarification will help save maintainers and new/rare
submitters time in the future.
Signed-off-by: NLuke Dashjr <luke-jr+git@utopios.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Commit messages lines are sometimes overly long.

Suggest line wrapping at 75 columns so the default git commit log
indentation of 4 plus the commit message text still fits on an 80 column
screen.

Add a checkpatch test for long commit messages lines too.
Signed-off-by: NJoe Perches <joe@perches.com>
Cc: David Miller <davem@davemloft.net>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Ian Morris <ipm@chirality.org.uk>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

The Developers Certificate of Origin has a mixture of tabs and white
spaces which is annoying to view if your editor explicitly views white
space characters.

Also remove any trailing white spaces found in the file.
Signed-off-by: NStefan Beller <sbeller@google.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Suggested-by: NMark Brown <broonie@kernel.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Suggested-by: NFrank Rowand <frowand.list@gmail.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Changes to make the formatting a bit more consistent and fix up wording in
various places.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

SubmittingPatches was written in the "keep sending to Linus until something
shows up in a release" era.  Given that we don't do things that way anymore
and the system is far less lossy, update this information and add some
hints on responding to reviewer comments.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

SubmittingPatches had two sections on selecting recipients; both were
showing their age.  Unify them into a single section that more closely
reflects how we do things now.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Much of the information in SubmittingPatches shows its pre-git history.
Clean that up a bit and rephrase things with the assumption that developers
will be using git.  Also rewrite the "pull requests" section and include
information on using signed tags.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This section was just a weird collection of stuff that is better found
elsewhere.  The "coding style" section somewhat duplicated the previous
coding style section; the useful information there has been collected into
a single place.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

The reported-by text says you have to ask for permission, but that
should only be if the bug was reported in private.  These days the
standard is to always give reported-by credit or it's considered a bit
rude.
Signed-off-by: NDan Carpenter <dan.carpenter@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

new link for - How to piss off a Linux kernel subsystem maintainer
Signed-off-by: NSudip Mukherjee <sudip@vectorindia.org>
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Maintainers often repeat the same feedback on poorly written
changelogs - describe the problem, justify your changes, quantify
optimizations, describe user-visible changes - but our documentation
on writing changelogs doesn't include these things.  Fix that.
Signed-off-by: NJohannes Weiner <hannes@cmpxchg.org>
Acked-by: NDavid S. Miller <davem@davemloft.net>
Acked-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: NIngo Molnar <mingo@kernel.org>
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

To keep the Documentation consistent either
"practise" or "practice" should be used.

Since there are 3 lines with "practise"

  ~/linux/Documentation$ grep -r practise * | wc -l
  3

and 108 lines with "practice"

  ~/linux/Documentation$ grep -r practice * | wc -l
  108

this patch converts "practise" to "practice".
Signed-off-by: NJeremiah Mahler <jmmahler@gmail.com>
Signed-off-by: NJiri Kosina <jkosina@suse.cz>

Update the SubmittingPatches process to include howto about the new
'Fixes:' tag to be used when a patch fixes an issue in a previous commit
(found by git-bisect for example).
Signed-off-by: NJacob Keller <jacob.e.keller@intel.com>
Tested-by: NAaron Brown <aaron.f.brown@intel.com>
Signed-off-by: NJeff Kirsher <jeffrey.t.kirsher@intel.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

The links to "The perfect patch" and "NO!!!! No more huge patch
bombs..." have gone stale. Update them to some working locations.
Signed-off-by: NMitchel Humpherys <mitchelh@codeaurora.org>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Most of the mechanical portions of SubmittingPatches exist to help patch
submitters replicate the output of git.  Mention this explicitly, both
as a reminder that git will help with this process, and as signposting
to let git users know what they can safely skip.
Signed-off-by: NJosh Triplett <josh@joshtriplett.org>
Acked-by: NBorislav Petkov <bp@suse.de>
Cc: Rob Landley <rob@landley.net>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

SubmittingPatches already mentions referencing bugs fixed by a commit,
but doesn't mention citing relevant mailing list discussions.  Add a
note to that effect, along with a recommendation to use the
https://lkml.kernel.org/ redirector.

Portions based on text from git's SubmittingPatches.
Signed-off-by: NJosh Triplett <josh@joshtriplett.org>
Acked-by: NBorislav Petkov <bp@suse.de>
Cc: Rob Landley <rob@landley.net>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Most commit messages use this style, and the recommendation frequently
comes up in discussions (especially in response to patches that don't
use it), but that recommendation doesn't actually appear anywhere in
Documentation.  Add this style guideline to SubmittingPatches, using the
description from git's SubmittingPatches.
Signed-off-by: NJosh Triplett <josh@joshtriplett.org>
Acked-by: NBorislav Petkov <bp@suse.de>
Cc: Rob Landley <rob@landley.net>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Request inclusion of oneline summaries when referring to other commits
Signed-off-by: NGeert Uytterhoeven <geert@linux-m68k.org>
Signed-off-by: NJiri Kosina <jkosina@suse.cz>

As people started using Suggested-by as standard signature, adding
"Suggested-by" to the standard signature so that checkpatch won't
generate warning when Suggested-by is used in patch signature
Signed-off-by: NMugunthan V N <mugunthanvnm@ti.com>
Cc: Andy Whitcroft <apw@canonical.com>
Cc: Joe Perches <joe@perches.com>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Update email address and CREDITS info.  xenotime.net is defunct.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Keiichi KII <k-keiichi@bx.jp.nec.com>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Had I found a reference to scripts/get_maintainer.pl when I first read
Documentation/SubmittingPatches, it would've saved me some time.
Signed-off-by: NMichel Machado <michel@digirati.com.br>
Acked-by: NRob Landley <rob@landley.net>
Signed-off-by: NJiri Kosina <jkosina@suse.cz>

Fixed a spelling error.
Signed-off-by: NZac Storer <zac.3.14159@gmail.com>
Signed-off-by: NRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Fixed the broken links in the SubmittingPatches file.

[ The old links turn out to not be broken after all, but the new links
  are certainly more readable - Linus ]
Signed-off-by: NVikram Narayanan <vikram186@gmail.com>
Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Fixes generated by 'codespell' and manually reviewed.
Signed-off-by: NLucas De Marchi <lucas.demarchi@profusion.mobi>

Add more information about patch descriptions.
Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
Reviewed-by: NChristoph Lameter <cl@linux-foundation.org>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

This patch size comment is like so last millenium.  Update it to modern
times.
Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

This patch fixes a reference to step "Select e-mail destination." which
has been renumbered from 4) to 5) in linux-2.6.22.
Signed-off-by: NMichael Brunner <mibru@gmx.de>
Acked-by: NRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: NJiri Kosina <jkosina@suse.cz>

It is outdated here and can be found in the MAINTAINERS file. Also
remove the URL of the previous maintainer, similar content can be found
in the SubmittingPatches file.
Signed-off-by: NMarkus Heidelberg <markus.heidelberg@web.de>
Signed-off-by: NJiri Kosina <jkosina@suse.cz>

Fix typo.
Signed-off-by: NPavel Machek <pavel@ucw.cz>
Signed-off-by: NJiri Kosina <jkosina@suse.cz>

Unfortunately many patch submissions are arriving with painfully poor
patch descriptions.   As a result of the discussion on LKML:

      http://lkml.org/lkml/2009/4/15/296

explain how to submit a better patch description, in the (perhaps
vain) hope that maintainers won't end up having to rewrite the git
commit logs as often as they do today.
Signed-off-by: N"Theodore Ts'o" <tytso@mit.edu>
Cc: Ingo Molnar <mingo@elte.hu>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Fix typo.
Signed-off-by: NPavel Machek <pavel@ucw.cz>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Randy pointed out that the Reported-By tag should be documented with the
others in SubmittingPatches.
Reported-by: NRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

For this year's OLS I wrote a paper on successfull strategies to submit
difficult kernel patches.  Add a reference to it to SubmittingPatches.
Signed-off-by: NAndi Kleen <ak@linux.intel.com>
Acked-by: NKOSAKI Motohiro <kosaki.motohiro@jp.fujitsu.com>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Remove Andrew Morton's http://www.zip.com.au/~akpm/ urls, update to new
ones when necessary, delete references otherwise.

There are still instances of that living in:
Documentation/zh_CN/HOWTO
Documentation/zh_CN/SubmittingPatches
Documentation/ko_KR/HOWTO
Documentation/ja_JP/SubmittingPatches
Signed-off-by: NFrancois Cami <francois.cami@free.fr>
Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Add a reference to paper to SubmittingPatches

For this year's OLS I wrote a paper on successfull strategies
to submit difficult kernel patches. Add a reference to it to
SubmittingPatches.
Signed-off-by: NAndi Kleen <ak@linux.intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Commonly used is "Tested-by."
Signed-off-by: NHidetoshi Seto <seto.hidetoshi@jp.fujitsu.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add git pull command info and diffstat summary info so that we don't
have to search email archives for it repeatedly.
Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>