24 Oct, 2016
3 commits
-
Those files got moved to Documentation/process, but as they're very
well known files, add pointers to their new locations.PS.: I opted to not merge this patch with the previous one
in order to make the diff of the previous one more consistent,
as it will show only renames.Signed-off-by: Mauro Carvalho Chehab
-
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
Signed-off-by: Mauro Carvalho Chehab -
As we'll type this a lot, after adding CodingStyle & friends,
let's rename the directory name to a shorter one.Signed-off-by: Mauro Carvalho Chehab
22 Sep, 2016
1 commit
-
Add cross references for the development process documents
that were converted to ReST:
Documentation/SubmitChecklist
Documentation/SubmittingDrivers
Documentation/SubmittingPatches
Documentation/development-process/development-process.rst
Documentation/stable_kernel_rules.txtSigned-off-by: Mauro Carvalho Chehab
Acked-by: Greg Kroah-Hartman
Signed-off-by: Jonathan Corbet
21 Sep, 2016
3 commits
-
Add cross references for the documents mentioned at HOWTO and
are under the Documentation/ directory, using the ReST notation.It should be noticed that HOWTO also mentions the /README file.
We opted to not touch it, for now, as making it build on
Sphinx would require it to be moved to a Documentation/foo
directory.Signed-off-by: Mauro Carvalho Chehab
Acked-by: Greg Kroah-Hartman
Signed-off-by: Jonathan Corbet -
Do a few changes to make the output look better:
- use bullets on trivial patches list;
- use monotonic font for tools name;
- use :manpage:`foo` for man pages;
- don't put all references to maintainer*html at the same line.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- Change the sections to use ReST markup;
- Add cross-references where needed;
- convert aspas to verbatim text;
- use code block tags;
- make Sphinx happy.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
26 Jan, 2016
1 commit
-
Signed-off-by: Jakub Wilk
Signed-off-by: Jonathan Corbet
14 Nov, 2015
1 commit
-
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
12 Nov, 2015
1 commit
-
Add a paragraph suggesting best practices for when to link patches
to previous LKML messages via In-Reply-To.Signed-off-by: Chris Metcalf
[jc: moved the added text to a separate section]
Signed-off-by: Jonathan Corbet
25 Sep, 2015
1 commit
-
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
Signed-off-by: Jonathan Corbet
02 Sep, 2015
1 commit
-
Pull trivial tree updates from Jiri Kosina:
"The usual stuff from trivial tree for 4.3 (kerneldoc updates, printk()
fixes, Documentation and MAINTAINERS updates)"* 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial: (28 commits)
MAINTAINERS: update my e-mail address
mod_devicetable: add space before */
scsi: a100u2w: trivial typo in printk
i2c: Fix typo in i2c-bfin-twi.c
treewide: fix typos in comment blocks
Doc: fix trivial typo in SubmittingPatches
proportions: Spelling s/consitent/consistent/
dm: Spelling s/consitent/consistent/
aic7xxx: Fix typo in error message
pcmcia: Fix typo in locking documentation
scsi/arcmsr: Fix typos in error log
drm/nouveau/gr: Fix typo in nv10.c
[SCSI] Fix printk typos in drivers/scsi
staging: comedi: Grammar s/Enable support a/Enable support for a/
Btrfs: Spelling s/consitent/consistent/
README: GTK+ is a acronym
ASoC: omap: Fix typo in config option description
mm: tlb.c: Fix error message
ntfs: super.c: Fix error log
fix typo in Documentation/SubmittingPatches
...
07 Aug, 2015
3 commits
-
This patch changes the tense of a verb in SubmittingPatches to ensure
grammatical validity of the containing sentence.Signed-off-by: Benjamin Herr
Signed-off-by: Jiri Kosina -
This adds a missing letter in Documentation/SubmittingPatches.
Signed-off-by: Nik Nyby
Signed-off-by: Jiri Kosina -
Signed-off-by: Jakub Wilk
Signed-off-by: Jonathan Corbet
24 Jul, 2015
1 commit
-
This patch changes the tense of a verb in SubmittingPatches to ensure
grammatical validity of the containing sentence.Signed-off-by: Benjamin Herr
Signed-off-by: Jonathan Corbet
15 Jul, 2015
2 commits
-
"facilitate easier reviewing" says the same thing twice.
Signed-off-by: Sébastien Hinderer
[jc: made it "easier review"]
Signed-off-by: Jonathan Corbet -
Signed-off-by: Sébastien Hinderer
Signed-off-by: Jonathan Corbet
11 Jul, 2015
1 commit
-
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
Signed-off-by: Jonathan Corbet
10 Jul, 2015
1 commit
-
From 7e0befc8e48a49e2ddf86bbd861027b14ea5a53d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Hinderer?=
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: Sébastien Hinderer
Signed-off-by: Jonathan Corbet
15 May, 2015
1 commit
-
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
Signed-off-by: Jonathan Corbet
17 Apr, 2015
1 commit
-
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
Cc: David Miller
Cc: Jonathan Corbet
Cc: Ian Morris
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
30 Jan, 2015
1 commit
-
Bring in the big SubmittingPatches thrashup.
Conflicts:
Documentation/SubmittingPatches
30 Dec, 2014
1 commit
-
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
Signed-off-by: Jonathan Corbet
24 Dec, 2014
2 commits
-
Suggested-by: Mark Brown
Signed-off-by: Jonathan Corbet -
Suggested-by: Frank Rowand
Signed-off-by: Jonathan Corbet
23 Dec, 2014
5 commits
-
Changes to make the formatting a bit more consistent and fix up wording in
various places.Signed-off-by: Jonathan Corbet
-
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
-
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
-
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
-
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
29 Oct, 2014
1 commit
-
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
Signed-off-by: Jonathan Corbet
08 Sep, 2014
1 commit
-
new link for - How to piss off a Linux kernel subsystem maintainer
Signed-off-by: Sudip Mukherjee
Signed-off-by: Randy Dunlap
Signed-off-by: Linus Torvalds
10 Aug, 2014
1 commit
-
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: Johannes Weiner
Acked-by: David S. Miller
Acked-by: Greg Kroah-Hartman
Acked-by: Ingo Molnar
Signed-off-by: Randy Dunlap
Signed-off-by: Linus Torvalds
07 Aug, 2014
1 commit
-
Pull trivial tree changes from Jiri Kosina:
"Summer edition of trivial tree updates"* 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial: (23 commits)
doc: fix two typos in watchdog-api.txt
irq-gic: remove file name from heading comment
MAINTAINERS: Add miscdevice.h to file list for char/misc drivers.
scsi: mvsas: mv_sas.c: Fix for possible null pointer dereference
doc: replace "practise" with "practice" in Documentation
befs: remove check for CONFIG_BEFS_RW
scsi: doc: fix 'SCSI_NCR_SETUP_MASTER_PARITY'
drivers/usb/phy/phy.c: remove a leading space
mfd: fix comment
cpuidle: fix comment
doc: hpfall.c: fix missing null-terminate after strncpy call
usb: doc: hotplug.txt code typos
kbuild: fix comment in Makefile.modinst
SH: add proper prompt to SH_MAGIC_PANEL_R2_VERSION
ARM: msm: Remove MSM_SCM
crypto: Remove MPILIB_EXTRA
doc: CN: remove dead link, kerneltrap.org no longer works
media: update reference, kerneltrap.org no longer works
hexagon: update reference, kerneltrap.org no longer works
doc: LSM: update reference, kerneltrap.org no longer works
...
19 Jun, 2014
1 commit
-
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
3and 108 lines with "practice"
~/linux/Documentation$ grep -r practice * | wc -l
108this patch converts "practise" to "practice".
Signed-off-by: Jeremiah Mahler
Signed-off-by: Jiri Kosina
07 Jun, 2014
1 commit
-
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: Jacob Keller
Tested-by: Aaron Brown
Signed-off-by: Jeff Kirsher
Cc: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
04 Apr, 2014
3 commits
-
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: Mitchel Humpherys
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds -
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: Josh Triplett
Acked-by: Borislav Petkov
Cc: Rob Landley
Cc: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds -
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: Josh Triplett
Acked-by: Borislav Petkov
Cc: Rob Landley
Cc: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
