summaryrefslogtreecommitdiffstats
path: root/Documentation/SubmittingPatches
Commit message (Collapse)AuthorAgeFilesLines
* Documentation/SubmittingPatches: update some dead URLsMitchel Humpherys2014-04-031-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 <mitchelh@codeaurora.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* SubmittingPatches: document the use of gitJosh Triplett2014-04-031-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 <josh@joshtriplett.org> Acked-by: Borislav Petkov <bp@suse.de> Cc: Rob Landley <rob@landley.net> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* SubmittingPatches: add recommendation for mailing list referencesJosh Triplett2014-04-031-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 <josh@joshtriplett.org> Acked-by: Borislav Petkov <bp@suse.de> Cc: Rob Landley <rob@landley.net> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* SubmittingPatches: add style recommendation to use imperative descriptionsJosh Triplett2014-04-031-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 <josh@joshtriplett.org> Acked-by: Borislav Petkov <bp@suse.de> Cc: Rob Landley <rob@landley.net> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation/SubmittingPatches: Request summaries for commit referencesGeert Uytterhoeven2013-08-201-0/+10
| | | | | | | Request inclusion of oneline summaries when referring to other commits Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
* checkpatch: add Suggested-by as a standard signatureMugunthan V N2013-04-291-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 <mugunthanvnm@ti.com> Cc: Andy Whitcroft <apw@canonical.com> Cc: Joe Perches <joe@perches.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Randy has movedRandy Dunlap2013-03-081-2/+1
| | | | | | | | | | Update email address and CREDITS info. xenotime.net is defunct. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Keiichi KII <k-keiichi@bx.jp.nec.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation/SubmittingPatches: suggested the use of scripts/get_maintainer.plMichel Machado2012-05-251-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 <michel@digirati.com.br> Acked-by: Rob Landley <rob@landley.net> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
* Documentation: fix spelling error in SubmittingPatchesZac Storer2011-08-131-1/+1
| | | | | | | | Fixed a spelling error. Signed-off-by: Zac Storer <zac.3.14159@gmail.com> Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation: update GregKH linksVikram Narayanan2011-05-231-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 <vikram186@gmail.com> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Fix common misspellingsLucas De Marchi2011-03-311-1/+1
| | | | | | Fixes generated by 'codespell' and manually reviewed. Signed-off-by: Lucas De Marchi <lucas.demarchi@profusion.mobi>
* SubmittingPatches: add more about patch descriptionsRandy Dunlap2010-08-091-0/+11
| | | | | | | | | Add more information about patch descriptions. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Reviewed-by: Christoph Lameter <cl@linux-foundation.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* docs: update patch size in SubmittingPatchesRandy Dunlap2009-10-011-1/+1
| | | | | | | | | This patch size comment is like so last millenium. Update it to modern times. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* trivial: SubmittingPatches: Fix reference to renumbered stepMichael Brunner2009-09-211-1/+1
| | | | | | | | | 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: Michael Brunner <mibru@gmx.de> Acked-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
* Merge branch 'for-linus' of ↵Linus Torvalds2009-06-141-3/+3
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial * 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial: (31 commits) trivial: remove the trivial patch monkey's name from SubmittingPatches trivial: Fix a typo in comment of addrconf_dad_start() trivial: usb: fix missing space typo in doc trivial: pci hotplug: adding __init/__exit macros to sgi_hotplug trivial: Remove the hyphen from git commands trivial: fix ETIMEOUT -> ETIMEDOUT typos trivial: Kconfig: .ko is normally not included in module names trivial: SubmittingPatches: fix typo trivial: Documentation/dell_rbu.txt: fix typos trivial: Fix Pavel's address in MAINTAINERS trivial: ftrace:fix description of trace directory trivial: unnecessary (void*) cast removal in sound/oss/msnd.c trivial: input/misc: Fix typo in Kconfig trivial: fix grammo in bus_for_each_dev() kerneldoc trivial: rbtree.txt: fix rb_entry() parameters in sample code trivial: spelling fix in ppc code comments trivial: fix typo in bio_alloc kernel doc trivial: Documentation/rbtree.txt: cleanup kerneldoc of rbtree.txt trivial: Miscellaneous documentation typo fixes trivial: fix typo milisecond/millisecond for documentation and source comments. ...
| * trivial: remove the trivial patch monkey's name from SubmittingPatchesMarkus Heidelberg2009-06-121-3/+3
| | | | | | | | | | | | | | | | | | 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: Markus Heidelberg <markus.heidelberg@web.de> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
| * trivial: SubmittingPatches: fix typoPavel Machek2009-06-121-1/+1
| | | | | | | | | | | | | | Fix typo. Signed-off-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
* | Documentation: Add "how to write a good patch summary" to SubmittingPatchesTheodore Ts'o2009-06-041-14/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: "Theodore Ts'o" <tytso@mit.edu> Cc: Ingo Molnar <mingo@elte.hu> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | SubmittingPatches: fix typoPavel Machek2009-06-041-1/+1
| | | | | | | | | | | | | | Fix typo. Signed-off-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Document Reported-by in SubmittingPatchesJonathan Corbet2009-06-041-1/+8
|/ | | | | | | | Randy pointed out that the Reported-By tag should be documented with the others in SubmittingPatches. Reported-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'docs' of git://git.lwn.net/linux-2.6Linus Torvalds2008-10-161-1/+1
|\ | | | | | | | | | | | | | | | | | | | | * 'docs' of git://git.lwn.net/linux-2.6: Document panic_on_unrecovered_nmi sysctl Add a reference to paper to SubmittingPatches Add kerneldoc documentation for new printk format extensions Remove videobook.tmpl doc: Test-by? Add the development process document Documentation/block/data-integrity.txt: Fix section numbers
| * Add a reference to paper to SubmittingPatchesAndi Kleen2008-10-161-0/+5
| | | | | | | | | | | | | | | | | | | | | | 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: Andi Kleen <ak@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: Test-by?Hidetoshi Seto2008-10-161-1/+1
| | | | | | | | | | | | | | Commonly used is "Tested-by." Signed-off-by: Hidetoshi Seto <seto.hidetoshi@jp.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | SubmittingPatches: add a reference to Andi's OLS paperAndi Kleen2008-10-161-0/+5
| | | | | | | | | | | | | | | | | | | | 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: Andi Kleen <ak@linux.intel.com> Acked-by: KOSAKI Motohiro <kosaki.motohiro@jp.fujitsu.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* | Remove Andrew Morton's http://www.zip.com.au/~akpm/FD Cami2008-10-161-2/+2
|/ | | | | | | | | | | | | | | 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: Francois Cami <francois.cami@free.fr> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* SubmittingPatches: add git pull & diffstat format infoRandy Dunlap2008-07-281-0/+26
| | | | | | | | 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: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* doc: add suggestions about good practises for maintainersWilly Tarreau2008-06-051-0/+46
| | | | | | | | Suggest how to deal with patch modifications caused by merging or back-porting when you're a maintainer. Signed-off-by: Willy Tarreau <w@1wt.eu> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Correct a few trivial tree details in Documentation/SubmittingPatchesJesper Juhl2008-04-211-2/+2
| | | | | | Correct maintainer name and URL. Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
* Merge branch 'docs' of git://git.lwn.net/linux-2.6Linus Torvalds2008-04-111-3/+51
|\ | | | | | | | | | | | | | | | | | | | | | | | | * 'docs' of git://git.lwn.net/linux-2.6: Add additional examples in Documentation/spinlocks.txt Move sched-rt-group.txt to scheduler/ Documentation: move rpc-cache.txt to filesystems/ Documentation: move nfsroot.txt to filesystems/ Spell out behavior of atomic_dec_and_lock() in kerneldoc Fix a typo in highres.txt Fixes to the seq_file document Fill out information on patch tags in SubmittingPatches Add the seq_file documentation
| * Fill out information on patch tags in SubmittingPatchesJonathan Corbet2008-03-301-3/+51
| | | | | | | | | | | | | | Add more information about the various patch tags in use, and try to establish a meaning for Reviewed-by: Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc: fix typo in SubmittingPatchesJim Meyering2008-04-021-1/+1
|/ | | | | | Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation: mention email-clients.txt in SubmittingPatchesMichael Opdenacker2008-02-031-14/+2
| | | | | | | | | | | | | | | | | | | I was struggling to get my email-client no to mangle my patch files, and I didn't find enough information in the SubmittingPatches file. By looking for more information on the web, I eventually found the email-clients.txt file, and it answered all my needs This patch adds a reference to email-clients.txt in SubmittingPatches, and Mozilla related information which is no longer accurate (as opposed to the details found in email-clients.txt). This should be helpful for people sending their first patches, or not sending patches on a frequent basis. Signed-off-by: Michael Opdenacker <michael@free-electrons.com> Acked-by: Randy Dunlap <randy.dunlap@oracle.com> Acked-by: Jeff Garzik <jeff@garzik.org> Signed-off-by: Adrian Bunk <bunk@kernel.org>
* fix typo in SubmittingPatchesKeiichi Kii2007-10-301-2/+2
| | | | | | | | | | Fix typo. Signed-off-by: Keiichi Kii <k-keiichi@bx.jp.nec.com> Cc: Andy Whitcroft <apw@shadowen.org> Cc: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* fix typo in Documentation/SubmittingPatchesAndre Haupt2007-09-111-1/+1
| | | | | | Signed-off-by: Andre Haupt <andre@finow14.de> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* HOWTO: latest lxr url address changedQi Yong2007-08-221-1/+1
| | | | | | | | | | | | | | | | Hello, I've noticed that in Document/HOWTO the url address: http://sosdg.org/~coywolf/lxr/ has changed to http://users.sosdg.org/~qiyong/lxr/ from the website. -- qiyong Signed-off-by: Qi Yong <qiyong@fc-cn.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* Documentation: Fix a mispelt "probably" in SubmittingPatches.Linus Nilsson2007-07-221-1/+1
| | | | | | | Fix a typo in SubmittingPatches where "probably" was spelt "probabally". Signed-off-by: Linus Nilsson <lajnold@gmail.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* update checkpatch.pl to version 0.07Andy Whitcroft2007-07-161-2/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This version brings a number of new checks, fixes for flase positives, plus a clarification of the output to better guide use. Of note: - checks for documentation for new __setup calls - clearer reporting where braces and parenthesis are involved - reports for closing brace and semi-colon spacing - reports on unwanted externs This patch includes an update to the documentation on checkpatch.pl itself to clarify when it should be used and to indicate that it is not intended as the final arbitor of style. Full changelog: Andy Whitcroft (19): Version: 0.07 ensure we do not apply control brace checks to preprocesor directives add {u,s}{8,16,32,64} to the type matcher accept lack of spacing after the semicolons in for (;;) report new externs in .c files fix up typedef exclusion for function prototypes else trailing statements check need to account for \ at end of line add enums to the type matcher add missing check descriptions suppress double reporting of ** spacing report on do{ spacing issues include an example of the brace/parenthesis in output check for spacing after closing braces prevent double reports on pointer spacing issues handle blank continuation lines on macros classify all reports error, warning, or check revamp hanging { checks and apply in context no spaces after the last ; in a for is ok check __setup has a corresponding addition to documentation David Woodhouse (1): limit character set used in patches and descriptions to UTF-8 Signed-off-by: Andy Whitcroft <apw@shadowen.org> Cc: David Woodhouse <dwmw2@infradead.org> Cc: "Randy.Dunlap" <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* document Acked-by:Andrew Morton2007-06-081-1/+25
| | | | | | | | Explain what we use Acked-by: for, and how it differs from Signed-off-by: Acked-by: Dave Jones <davej@redhat.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* add a trivial patch style checkerAndy Whitcroft2007-06-011-11/+28
| | | | | | | | | | | | | | | | | We are seeing increasing levels of minor patch style violations in submissions to the mailing lists as well as making it into the tree. These detract from the quality of the submission and cause unnessary work for reviewers. As a first step package up the current state of the patch style checker and include it in the kernel tree. Add instructions suggesting running it on submissions. This adds version v0.01 of the checkpatch.pl script. Signed-off-by: Andy Whitcroft <apw@shadowen.org> Signed-off-by: Joel Schopp <jschopp@austin.ibm.com> Cc: Randy Dunlap <rdunlap@xenotime.net> Cc: Dave Jones <davej@codemonkey.org.uk> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* doc: what a patch series isRandy Dunlap2007-05-091-1/+2
| | | | | | | | | | It seems that we need to clarify that a patch series is a series of related patches rather than "here are some of my patches as multiple (numbered) emails." Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Change Linus' email address tooLinus Torvalds2007-01-231-3/+3
| | | | | | | This changes a few mentions of my email address to point to the new one, leaving things like old copyright messages alone. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* [PATCH] SubmittingPatches: add a note about "format=flowed" when sending patchesKirill Korotaev2006-09-291-0/+13
| | | | | | | | | Add a note about "format=flowed" when sending patches and explain how to fix mozilla. Thunderbird has the similar options. Signed-off-by: Kirill Korotaev <dev@openvz.org> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] SubmittingPatches cleanupsPavel Machek2006-09-291-13/+13
| | | | | | | | This cleans up SubmittingPatches a bit. Signed-off-by: Pavel Machek <pavel@suse.cz> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] We can not allow anonymous contributions to the kernelGreg KH2006-09-131-0/+2
| | | | | | | | | | The DCO does not mean anything if we allow anonymous contributors to the kernel. As this is an open source project, we need to do everything in the open. Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] Doc/SubmittingPatches cleanupsRandy Dunlap2006-07-311-6/+4
| | | | | | | | | | | A few cleanups to SubmittingPatches: - mention SubmitChecklist - remove mention of my simple patch script tools - remove last-updated line Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] docs: update some updated code docsXose Vazquez Perez2006-01-141-1/+2
| | | | | | | Based on comments from Randy Dunlap on my previous commit 5b0ed2c64d8fdafb5fcfb3baabdd288628b1ff9b Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] SubmittingPatches: diffstat optionsRandy Dunlap2006-01-081-0/+3
| | | | | | | | Add desired 'diffstat' options to use for kernel patches. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] docs: updated some code docsXose Vazquez Perez2006-01-081-18/+42
| | | | | Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* Documentation/SubmittingPatches: update Trivial Patch Monkey informationKees Cook2006-01-031-2/+2
| | | | | | | | While looking for where to send trivial patches, I found old contact information in Documentation/SubmittingPatches. Signed-off-by: Kees Cook <kees@outflux.net> Signed-off-by: Adrian Bunk <bunk@stusta.de>
* [PATCH] Document patch subject line betterPaul Jackson2005-10-031-4/+20
| | | | | | | | Improve explanation of the Subject line fields in Documentation/SubmittingPatches Canonical Patch Format. Signed-off-by: Paul Jackson <pj@sgi.com> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
OpenPOWER on IntegriCloud