summaryrefslogtreecommitdiffstats
path: root/Documentation/SubmitChecklist
Commit message (Collapse)AuthorAgeFilesLines
* docs-rst: add inter-document cross referencesMauro Carvalho Chehab2016-09-211-4/+6
| | | | | | | | | | | | | | 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 <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/SubmitChecklist: convert it to ReST markupMauro Carvalho Chehab2016-09-201-54/+62
| | | | | | | | | | | | | | | | - use ``foo`` to markup inline literal stuff, effectively making it to be presented as a monospaced font when parsed by Sphinx; - the markup below the title should have the same length as the title; - Fix the list markups, from "1:" to "1)"; - Split item 2 into a separate list for the build options, in order to be presented as a list on Sphinx; Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/SubmitChecklist: update kernel-doc taskMauro Carvalho Chehab2016-09-201-3/+4
| | | | | | | | | | | | Task 11 (kernel-doc) still mentions usage of make manpages, but this won't work if the API is documented via Sphinx. So, update it to use either htmldocs or pdfdocs, with are the documentation targets that work for all. While here, add ReST reference to the kernel documentation book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Finally eradicate CONFIG_HOTPLUGStephen Rothwell2013-06-031-1/+1
| | | | | | | | | | | | | | | | | | | Ever since commit 45f035ab9b8f ("CONFIG_HOTPLUG should be always on"), it has been basically impossible to build a kernel with CONFIG_HOTPLUG turned off. Remove all the remaining references to it. Cc: Russell King <linux@arm.linux.org.uk> Cc: Doug Thompson <dougthompson@xmission.com> Cc: Bjorn Helgaas <bhelgaas@google.com> Cc: Steven Whitehouse <swhiteho@redhat.com> Cc: Arnd Bergmann <arnd@arndb.de> Cc: Pavel Machek <pavel@ucw.cz> Cc: "Rafael J. Wysocki" <rjw@sisk.pl> Cc: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au> Acked-by: Mauro Carvalho Chehab <mchehab@redhat.com> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Documentation/SubmitChecklist: add RCU debug config optionsPaul E. McKenney2011-07-251-2/+2
| | | | | | | | | | | There have been persistent lockdep RCU splats, indicating that submitters are not testing with CONFIG_PROVE_RCU. Add this config option to the list in Documentation/SubmitChecklist. Also add CONFIG_DEBUG_OBJECTS_RCU_HEAD for good measure. Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* sched: Generalize sleep inside spinlock detectionFrederic Weisbecker2011-06-231-1/+1
| | | | | | | | | | | | | | | | The sleeping inside spinlock detection is actually used for more general sleeping inside atomic sections debugging: preemption disabled, rcu read side critical sections, interrupts, interrupt disabled, etc... Change the name of the config and its help section to reflect its more general role. Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com> Acked-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com> Acked-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: Peter Zijlstra <a.p.zijlstra@chello.nl> Cc: Ingo Molnar <mingo@elte.hu>
* Documentation: update SubmitChecklist for O=objdir and kconfig testingRandy Dunlap2010-05-241-0/+12
| | | | | | | | | | Add build testing using 'O=builddir'. Add build testing with various kconfig symbols disabled, listing common ones that are known to cause build problems. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation/SubmitChecklist: add rule #1Randy Dunlap2010-03-121-2/+6
| | | | | | | | | | | | Add header file requirements. Compliments of Stephen Rothwell. Stephen calls this Rule #1, so I put it there, but I didn't want to demote any of the others in the list, so I made one of them number 2b. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* doc: SubmitChecklist, add ioctls, remove OSDL referenceRandy Dunlap2009-12-161-1/+4
| | | | | | | | | | | If a patch adds ioctls, then Documentation/ioctl/ioctl-number.txt should also be updated. Remove reference to the OSDL PLM build farm. 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>
* block: rename CONFIG_LBD to CONFIG_LBDAFBartlomiej Zolnierkiewicz2009-06-191-1/+1
| | | | | | | | | | | | Follow-up to "block: enable by default support for large devices and files on 32-bit archs". Rename CONFIG_LBD to CONFIG_LBDAF to: - allow update of existing [def]configs for "default y" change - reflect that it is used also for large files support nowadays Signed-off-by: Bartlomiej Zolnierkiewicz <bzolnier@gmail.com> Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
* documentation: explain memory barriersRandy Dunlap2008-10-161-0/+3
| | | | | | | | We want all uses of memory barriers to be explained in the source code. 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>
* SubmitChecklist: interfaces changes should CC linux-api@Michael Kerrisk2008-10-031-0/+2
| | | | | | | | | Mention that patches that change the kernel-userland interface should be CCed to the new list linux-api@vger.kernel.org. Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation: prune redundant SubmitChecklist itemsJ. Bruce Fields2008-02-131-11/+5
| | | | | | | | | | | Kernel style is mentioned twice, and the git apply trick is a bit redundant given the checkpatch.pl recommendation (which also checks for bad whitespace). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Cc: "Randy.Dunlap" <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Documentation: Fix typo in SubmitChecklist.James Bowes2007-10-201-1/+1
| | | | | Signed-off-by: James Bowes <jbowes@dangerouslyinc.com> Signed-off-by: Adrian Bunk <bunk@kernel.org>
* SubmitChecklist update, fix spelling errorJesper Juhl2007-07-161-2/+1
| | | | | | Signed-off-by: Jesper Juhl <jesper.juhl@gmail.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-0/+6
| | | | | | | | | | | | | | | | | 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>
* SubmitChecklist: add -W helpAndrew Morton2007-05-111-3/+3
| | | | | | | Help people to work out how to use `gcc -W'. Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* Add info about whitespace to SubmitChecklistRoland Dreier2007-05-091-0/+4
| | | | | | Signed-off-by: Roland Dreier <rolandd@cisco.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* [PATCH] add -mm testing in SubmitChecklistRandy Dunlap2007-03-011-0/+4
| | | | | | | | Add -mm testing to SubmitChecklist. 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>
* [PATCH] SubmitChecklist updateAndrew Morton2007-01-231-0/+4
| | | | | | | | | | Sing the praises of `gcc -W'. Would have prevented that blockdev direct-IO bug. Cc: "Chen, Kenneth W" <kenneth.w.chen@intel.com> Cc: "Randy.Dunlap" <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* [PATCH] submit checklist updateAndrew Morton2006-12-101-0/+6
| | | | | | | Mention the new fault-injection test framework. Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] submit checklist: mention headers_checkAndrew Morton2006-10-011-0/+2
| | | | | | Cc: David Woodhouse <dwmw2@infradead.org> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] Mention Documenation/ABI/ requirements in Documentation/SubmitChecklistRandy Dunlap2006-09-291-0/+3
| | | | | | | | | Mention Documenation/ABI/ requirements in Documentation/SubmitChecklist. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Cc: Greg KH <greg@kroah.com> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] checklist updateAndrew Morton2006-07-101-35/+41
| | | | | | | | | | | | | Update Documentation/SubmitChecklist. - Mention lockdep coverage - Describe documentation requirements - Number the various items to simplify the composition of caustic emails. Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] add Doc/SubmitChecklistRandy Dunlap2006-06-231-0/+57
Provide a checklist of techniques to aid kernel patch submitters in producing healthy patches and in lessening a burden on maintainers. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 13:11:04 +0000