Pull more documentation updates from Jon Corbet:
"A few more documentation patches that wandered in and have no reason
to wait; these include some improvements to the suggestions for email
clients and patch submission"
* tag '4.4-additional' of git://git.lwn.net/linux:
Documentation: Add minimal Mutt config for using Gmail
Documentation: Add note on sending files directly with Mutt
Documentation: dontdiff: remove media from dontdiff
Documentation/SubmittingPatches: discuss In-Reply-To
Remove email address from Documentation/filesystems/overlayfs.txt
can-doc: Add missing semicolon to example
Add a paragraph suggesting best practices for when to link patches
to previous LKML messages via In-Reply-To.
Signed-off-by: Chris Metcalf <cmetcalf@ezchip.com>
[jc: moved the added text to a separate section]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
The examples should better match what kernel developers actually expect,
so that they set a good example both for this project and for other
projects with similar development processes.
Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This patch changes the tense of a verb in SubmittingPatches to ensure
grammatical validity of the containing sentence.
Signed-off-by: Benjamin Herr <ben@0x539.de>
Signed-off-by: Jiri Kosina <jkosina@suse.com>
This patch changes the tense of a verb in SubmittingPatches to ensure
grammatical validity of the containing sentence.
Signed-off-by: Benjamin Herr <ben@0x539.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
"facilitate easier reviewing" says the same thing twice.
Signed-off-by: Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
[jc: made it "easier review"]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link to the internal up to date Coding Style document inside the Kernel
sources instead of an external one.
Signed-off-by: Luis de Bethencourt <luis@debethencourt.com>
Signed-off-by: Jonathan 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: Luke Dashjr <luke-jr+git@utopios.org>
Signed-off-by: Jonathan 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: Joe 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: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus 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: Stefan Beller <sbeller@google.com>
Signed-off-by: Jonathan 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: Jonathan 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: Jonathan 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: Jonathan 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: Jonathan 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: Dan Carpenter <dan.carpenter@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jakub Wilk
Linus Torvalds
Chris Metcalf
Alex Henrie
Benjamin Herr
Nik Nyby
Sébastien Hinderer
Luis de Bethencourt
Luke Dashjr
Joe Perches
Jonathan Corbet
Stefan Beller
Dan Carpenter