aboutsummaryrefslogtreecommitdiff
path: root/Documentation/SubmittingPatches
AgeCommit message (Collapse)AuthorFilesLines
2016-10-24doc: re-add CodingStyle and SubmittingPatchesMauro Carvalho Chehab1-0/+1
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 <[email protected]>
2016-10-24docs-rst: add documents to development-processMauro Carvalho Chehab1-841/+0
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 <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2016-10-24docs: rename development-process/ to process/Mauro Carvalho Chehab1-1/+1
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 <[email protected]>
2016-09-21docs-rst: add inter-document cross referencesMauro Carvalho Chehab1-9/+15
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.txt Signed-off-by: Mauro Carvalho Chehab <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-09-20Documentation/HOWTO: add cross-references to other documentsMauro Carvalho Chehab1-0/+1
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 <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-09-20Documentation/SubmittingPatches: enrich the Sphinx outputMauro Carvalho Chehab1-45/+55
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-09-20Documentation/SubmittingPatches: convert it to ReST markupMauro Carvalho Chehab1-102/+105
- 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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-01-25SubmittingPatches: fix spelling of "git send-email"Jakub Wilk1-1/+1
Signed-off-by: Jakub Wilk <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-11-13Merge tag '4.4-additional' of git://git.lwn.net/linuxLinus Torvalds1-1/+14
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
2015-11-11Documentation/SubmittingPatches: discuss In-Reply-ToChris Metcalf1-1/+14
Add a paragraph suggesting best practices for when to link patches to previous LKML messages via In-Reply-To. Signed-off-by: Chris Metcalf <[email protected]> [jc: moved the added text to a separate section] Signed-off-by: Jonathan Corbet <[email protected]>
2015-09-24SubmittingPatches: make Subject examples match the de facto standardAlex Henrie1-4/+4
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-09-01Merge branch 'for-next' of ↵Linus Torvalds1-1/+1
git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial 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 ...
2015-08-07Doc: fix trivial typo in SubmittingPatchesBenjamin Herr1-1/+1
This patch changes the tense of a verb in SubmittingPatches to ensure grammatical validity of the containing sentence. Signed-off-by: Benjamin Herr <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2015-08-07fix typo in Documentation/SubmittingPatchesNik Nyby1-1/+1
This adds a missing letter in Documentation/SubmittingPatches. Signed-off-by: Nik Nyby <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2015-08-06SubmittingPatches: remove stray quote characterJakub Wilk1-1/+1
Signed-off-by: Jakub Wilk <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-07-24Doc: fix trivial typo in SubmittingPatchesBenjamin Herr1-1/+1
This patch changes the tense of a verb in SubmittingPatches to ensure grammatical validity of the containing sentence. Signed-off-by: Benjamin Herr <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-07-14SubmittingPatches: fix wrong wordingSébastien Hinderer1-1/+1
"facilitate easier reviewing" says the same thing twice. Signed-off-by: Sébastien Hinderer <[email protected]> [jc: made it "easier review"] Signed-off-by: Jonathan Corbet <[email protected]>
2015-07-14SubmittingPatches: fix wrong wordingSébastien Hinderer1-1/+1
Signed-off-by: Sébastien Hinderer <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-07-10SubmittingPatches: update CodingStyle referenceLuis de Bethencourt1-1/+1
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-07-09SubmittingPatches: fix typoSébastien Hinderer1-1/+1
From 7e0befc8e48a49e2ddf86bbd861027b14ea5a53d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Hinderer?= <[email protected]> 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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-05-14SubmittingPatches: Clarify requirements for patches directed toward stableLuke Dashjr1-1/+3
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-04-17checkpatch, SubmittingPatches: suggest line wrapping commit messages at 75 ↵Joe Perches1-2/+2
columns 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 <[email protected]> Cc: David Miller <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Ian Morris <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2015-01-29Merge branch 'doc/sp-update' into docs-nextJonathan Corbet1-220/+216
Bring in the big SubmittingPatches thrashup. Conflicts: Documentation/SubmittingPatches
2014-12-29Documentation/SubmittingPatches: unify whitespace/tabs for the DCOStefan Beller1-8/+8
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2014-12-23Docs: SubmittingPatches: mention using pull requests as a cover letterJonathan Corbet1-1/+3
Suggested-by: Mark Brown <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2014-12-23Docs: Mention device tree binding infoJonathan Corbet1-1/+2
Suggested-by: Frank Rowand <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2014-12-23Docs: SubmittingPatches: miscellaneous cleanupsJonathan Corbet1-23/+38
Changes to make the formatting a bit more consistent and fix up wording in various places. Signed-off-by: Jonathan Corbet <[email protected]>
2014-12-23Docs: SubmittingPatches: update follow-through instructionsJonathan Corbet1-28/+22
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 <[email protected]>
2014-12-23Docs: Update recipient information in SubmittingPatchesJonathan Corbet1-53/+54
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 <[email protected]>
2014-12-23Docs: Bring SubmittingPatches more into the git eraJonathan Corbet1-29/+87
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 <[email protected]>
2014-12-23Docs: Remove "tips and tricks" from SubmittingPatchesJonathan Corbet1-96/+21
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 <[email protected]>
2014-10-29Documentation/SubmittingPatches: Reported-by tags and permissionDan Carpenter1-6/+4
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2014-09-07Documentation: new page link in SubmittingPatchesSudip Mukherjee1-0/+1
new link for - How to piss off a Linux kernel subsystem maintainer Signed-off-by: Sudip Mukherjee <[email protected]> Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2014-08-09Documentation: SubmittingPatches: overhaul changelog descriptionJohannes Weiner1-7/+31
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 <[email protected]> Acked-by: David S. Miller <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Acked-by: Ingo Molnar <[email protected]> Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2014-08-06Merge branch 'for-linus' of ↵Linus Torvalds1-2/+2
git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial 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 ...
2014-06-19doc: replace "practise" with "practice" in DocumentationJeremiah Mahler1-2/+2
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: Jeremiah Mahler <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2014-06-06Documentation/SubmittingPatches: describe the Fixes: tagJacob Keller1-1/+21
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 <[email protected]> Tested-by: Aaron Brown <[email protected]> Signed-off-by: Jeff Kirsher <[email protected]> Cc: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2014-04-03Documentation/SubmittingPatches: update some dead URLsMitchel Humpherys1-2/+2
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 <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2014-04-03SubmittingPatches: document the use of gitJosh Triplett1-15/+16
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 <[email protected]> Acked-by: Borislav Petkov <[email protected]> Cc: Rob Landley <[email protected]> Cc: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2014-04-03SubmittingPatches: add recommendation for mailing list referencesJosh Triplett1-1/+9
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 <[email protected]> Acked-by: Borislav Petkov <[email protected]> Cc: Rob Landley <[email protected]> Cc: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2014-04-03SubmittingPatches: add style recommendation to use imperative descriptionsJosh Triplett1-0/+5
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: Josh Triplett <[email protected]> Acked-by: Borislav Petkov <[email protected]> Cc: Rob Landley <[email protected]> Cc: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2013-08-20Documentation/SubmittingPatches: Request summaries for commit referencesGeert Uytterhoeven1-0/+10
Request inclusion of oneline summaries when referring to other commits Signed-off-by: Geert Uytterhoeven <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2013-04-29checkpatch: add Suggested-by as a standard signatureMugunthan V N1-1/+8
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: Mugunthan V N <[email protected]> Cc: Andy Whitcroft <[email protected]> Cc: Joe Perches <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2013-03-08Randy has movedRandy Dunlap1-2/+1
Update email address and CREDITS info. xenotime.net is defunct. Signed-off-by: Randy Dunlap <[email protected]> Cc: Harry Wei <[email protected]> Cc: Keiichi KII <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2012-05-25Documentation/SubmittingPatches: suggested the use of scripts/get_maintainer.plMichel Machado1-1/+2
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: Michel Machado <[email protected]> Acked-by: Rob Landley <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2011-08-13Documentation: fix spelling error in SubmittingPatchesZac Storer1-1/+1
Fixed a spelling error. Signed-off-by: Zac Storer <[email protected]> Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2011-05-23Documentation: update GregKH linksVikram Narayanan1-4/+5
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: Vikram Narayanan <[email protected]> Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2011-03-31Fix common misspellingsLucas De Marchi1-1/+1
Fixes generated by 'codespell' and manually reviewed. Signed-off-by: Lucas De Marchi <[email protected]>
2010-08-09SubmittingPatches: add more about patch descriptionsRandy Dunlap1-0/+11
Add more information about patch descriptions. Signed-off-by: Randy Dunlap <[email protected]> Reviewed-by: Christoph Lameter <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2009-10-01docs: update patch size in SubmittingPatchesRandy Dunlap1-1/+1
This patch size comment is like so last millenium. Update it to modern times. Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
Powered by cgit, Gruvboxed by Blaster4385.