aboutsummaryrefslogtreecommitdiff
path: root/Documentation/SubmitChecklist
AgeCommit message (Collapse)AuthorFilesLines
2016-10-24docs-rst: add documents to development-processMauro Carvalho Chehab1-120/+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-09-21docs-rst: add inter-document cross referencesMauro Carvalho Chehab1-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 <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-09-20Documentation/SubmitChecklist: convert it to ReST markupMauro Carvalho Chehab1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-09-20Documentation/SubmitChecklist: update kernel-doc taskMauro Carvalho Chehab1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2013-06-03Finally eradicate CONFIG_HOTPLUGStephen Rothwell1-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 <[email protected]> Cc: Doug Thompson <[email protected]> Cc: Bjorn Helgaas <[email protected]> Cc: Steven Whitehouse <[email protected]> Cc: Arnd Bergmann <[email protected]> Cc: Pavel Machek <[email protected]> Cc: "Rafael J. Wysocki" <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Stephen Rothwell <[email protected]> Acked-by: Mauro Carvalho Chehab <[email protected]> Acked-by: Hans Verkuil <[email protected]> Signed-off-by: Greg Kroah-Hartman <[email protected]>
2011-07-25Documentation/SubmitChecklist: add RCU debug config optionsPaul E. McKenney1-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 <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2011-06-23sched: Generalize sleep inside spinlock detectionFrederic Weisbecker1-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 <[email protected]> Acked-by: Paul E. McKenney <[email protected]> Acked-by: Randy Dunlap <[email protected]> Cc: Peter Zijlstra <[email protected]> Cc: Ingo Molnar <[email protected]>
2010-05-24Documentation: update SubmitChecklist for O=objdir and kconfig testingRandy Dunlap1-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 <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2010-03-12Documentation/SubmitChecklist: add rule #1Randy Dunlap1-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 <[email protected]> Cc: Stephen Rothwell <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2009-12-16doc: SubmitChecklist, add ioctls, remove OSDL referenceRandy Dunlap1-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 <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2009-06-19block: rename CONFIG_LBD to CONFIG_LBDAFBartlomiej Zolnierkiewicz1-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 <[email protected]> Signed-off-by: Jens Axboe <[email protected]>
2008-10-16documentation: explain memory barriersRandy Dunlap1-0/+3
We want all uses of memory barriers to be explained in the source code. Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2008-10-03SubmitChecklist: interfaces changes should CC linux-api@Michael Kerrisk1-0/+2
Mention that patches that change the kernel-userland interface should be CCed to the new list [email protected]. Signed-off-by: Michael Kerrisk <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2008-02-13Documentation: prune redundant SubmitChecklist itemsJ. Bruce Fields1-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 <[email protected]> Cc: "Randy.Dunlap" <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-10-20Documentation: Fix typo in SubmitChecklist.James Bowes1-1/+1
Signed-off-by: James Bowes <[email protected]> Signed-off-by: Adrian Bunk <[email protected]>
2007-07-16SubmitChecklist update, fix spelling errorJesper Juhl1-2/+1
Signed-off-by: Jesper Juhl <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-06-01add a trivial patch style checkerAndy Whitcroft1-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 <[email protected]> Signed-off-by: Joel Schopp <[email protected]> Cc: Randy Dunlap <[email protected]> Cc: Dave Jones <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-05-11SubmitChecklist: add -W helpAndrew Morton1-3/+3
Help people to work out how to use `gcc -W'. Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-05-09Add info about whitespace to SubmitChecklistRoland Dreier1-0/+4
Signed-off-by: Roland Dreier <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-03-01[PATCH] add -mm testing in SubmitChecklistRandy Dunlap1-0/+4
Add -mm testing to SubmitChecklist. Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-01-23[PATCH] SubmitChecklist updateAndrew Morton1-0/+4
Sing the praises of `gcc -W'. Would have prevented that blockdev direct-IO bug. Cc: "Chen, Kenneth W" <[email protected]> Cc: "Randy.Dunlap" <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2006-12-10[PATCH] submit checklist updateAndrew Morton1-0/+6
Mention the new fault-injection test framework. Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2006-10-01[PATCH] submit checklist: mention headers_checkAndrew Morton1-0/+2
Cc: David Woodhouse <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2006-09-29[PATCH] Mention Documenation/ABI/ requirements in Documentation/SubmitChecklistRandy Dunlap1-0/+3
Mention Documenation/ABI/ requirements in Documentation/SubmitChecklist. Signed-off-by: Randy Dunlap <[email protected]> Cc: Greg KH <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2006-07-10[PATCH] checklist updateAndrew Morton1-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 <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2006-06-23[PATCH] add Doc/SubmitChecklistRandy Dunlap1-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 <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
Powered by cgit, Gruvboxed by Blaster4385.