summaryrefslogtreecommitdiffstats
path: root/Documentation/HOWTO
AgeCommit message (Collapse)AuthorFilesLines
2016-10-24docs-rst: add documents to development-processMauro Carvalho Chehab1-652/+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 <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-20docs: Clean up bare :: linesJonathan Corbet1-9/+3
Mauro's patch set introduced some bare :: lines; these can be represented by a double colon at the end of the preceding text line. The result looks a little less weird and is less verbose. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-20Documentation/HOWTO: adjust external link referencesMauro Carvalho Chehab1-20/+17
- A few link references were missing http:// - Several sites are now redirecting to https protocol. On such cases, just use the https URL. NOTE: all URLs were checked and they're pointing to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-20Documentation/HOWTO: improve some markups to make it visually betterMauro Carvalho Chehab1-20/+16
Do a series of minor improvements at the ReST output format: - Instead of using the quote blocks (::) for quotes, use italics. That looks nicer on epub (and html) output, as no scroll bar will be added. Also, it will adjust line breaks on the text automatically. - Add a missing reference to SubmittingPatches.rst and use **foo** instead of _foo_. - use bold for "The Perfect Patch" by removing a newline. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-20Documentation/HOWTO: update information about generating documentationMauro Carvalho Chehab1-6/+22
The description there are pre-Sphinx. Update it to cover the new way. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-20Documentation/HOWTO: add cross-references to other documentsMauro Carvalho Chehab1-9/+9
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 <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-20Documentation/HOWTO: convert to ReST notationMauro Carvalho Chehab1-4/+49
This document is almost compliant with ReST notation, but some small adjustments are needed to make it parse properly by Sphinx (mostly, add blank lines where needed). Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-03-09Documentation: Howto: Fixed subtitles stylePhilippe Loctaux1-4/+4
Fixed subtitles style, aligned them with their header. Signed-off-by: Philippe Loctaux <phil@philippeloctaux.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-02-10Documentation: HOWTO: remove obsolete info about regression postingsPeter Loeffler1-6/+1
corbet@lwn.net told me that these regression postings haven't happened for several years. So i think we can remove it. Signed-off-by: Peter Loeffler <peter.loeffler@guruz.at> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10Documentation: HOWTO: update code cross reference linkDoug Smythies1-1/+1
The source code cross reference link does not work. Update the link to a site that works. Signed-off-by: Doug Smythies <dsmythies@telus.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-08-24docs: update HOWTO for 3.x -> 4.x versioningMario Carrillo1-14/+14
The HOWTO document needed updating for the new kernel versioning. Signed-off-by: Mario Carrillo <mario.alfredo.c.arevalo@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2014-10-28Documentation: remove outdated references to the linux-next wikiJim Davis1-1/+0
The linux-next wiki at http://linux.f-seidel.de/linux-next/pmwiki has been gone for several months now. Signed-off-by: Jim Davis <jim.epost@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2013-12-10Documentation: HOWTO: Update broken links to tppSeongJae Park1-2/+2
Sites for 'The Perfect Patch' which described on HOWTO document(kerneltrap.org and userweb.kernel.org) are down. Change those links to the copy at ozlabs. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2013-06-03Documentation: Updated broken link in HOWTOBen Minerds1-1/+1
Updated broken "The Perfect Patch" link in HOWTO to a copy at kerneltrap.org. Signed-off-by: Ben Minerds <puzzleduck@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2012-12-10HOWTO: fix double words typoCristian Stoica1-1/+1
Signed-off-by: Cristian Stoica <cristian.stoica@freescale.com> Acked-by: Rob Landley <rob@landley.net> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2012-04-19docs: update HOWTO for 2.6.x -> 3.x versioningKees Cook1-16/+16
The HOWTO document needed updating for the new kernel versioning. The git URI for -next was updated as well. Signed-off-by: Kees Cook <keescook@chromium.org> Cc: stable <stable@vger.kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2011-12-12Documentation: Update stable addressJoe Perches1-2/+2
The Japanese/Korean/Chinese versions still need updating. Also, the stable kernel 2.6.x.y descriptions are out of date and should be updated as well. Signed-off-by: Joe Perches <joe@perches.com> Cc: stable <stable@vger.kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-05-23Documentation: update LXR web linkHarry Wei1-1/+1
Update LXR (Linux cross reference) web link. Signed-off-by: Harry Wei <harryxiyou@gmail.com> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2010-08-04Documentation: update broken web addresses.Justin P. Mattock1-3/+3
Below you will find an updated version from the original series bunching all patches into one big patch updating broken web addresses that are located in Documentation/* Some of the addresses date as far far back as 1995 etc... so searching became a bit difficult, the best way to deal with these is to use web.archive.org to locate these addresses that are outdated. Now there are also some addresses pointing to .spec files some are located, but some(after searching on the companies site)where still no where to be found. In this case I just changed the address to the company site this way the users can contact the company and they can locate them for the users. Signed-off-by: Justin P. Mattock <justinmattock@gmail.com> Signed-off-by: Thomas Weber <weber@corscience.de> Signed-off-by: Mike Frysinger <vapier.adi@gmail.com> Cc: Paulo Marques <pmarques@grupopie.com> Cc: Randy Dunlap <rdunlap@xenotime.net> Cc: Michael Neuling <mikey@neuling.org> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2010-04-22Documentation/HOWTO: update git home URLRandy Dunlap1-1/+1
Update git home page info. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2010-03-07HOWTO: Updates on subsystem trees, patchwork, -next (vs. -mm)Stefan Richter1-77/+36
One of the roles which -mm fulfilled some time ago (to offer an integration testing ground) has been taken over by -next. This is still news to Documentation/HOWTO, so mention it there. Also add a word on how patchwork is used to track patches as they make their way into subsystem trees. Remove some arbitrary links to subsystem repositories; they can all be found in the MAINTAINERS database. Acked-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-10-16Remove Andrew Morton's http://www.zip.com.au/~akpm/FD Cami1-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>
2008-10-03Documentation/HOWTO: info about interface changes should CC linux-api@vgerMichael Kerrisk1-1/+2
The "Documentation" section of this file mentions that when an interface change is made, I should be CCed with info about the change (so that man-pages can document it). Additionally request that this info be CCed to the new linux-api@vger.kernel.org list. 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>
2008-07-21HOWTO: change email addresses of James in HOWTOTsugikazu Shibata1-1/+1
Signed-off-by: Tsugikazu Shibata <tshibata@ab.jp.nec.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-07-13Documentation/HOWTO: correct wrong kernel bugzilla FAQ URLJiri Pirko1-1/+1
Signed-off-by: Jiri Pirko <jpirko@redhat.com> Cc: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-04-25Various fixes to Documentation/HOWTOJonathan Corbet1-11/+19
Fix a number of things which have gone somewhat out-of-date over the last few months. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2007-10-17Change man-pages maintainer addressMichael Kerrisk1-1/+1
The email address that I use for man-pages maintenance has changed as of now. This patch changes the address in Documentation/HOWTO and MAINTAINERS. Signed-off-by: Michael Kerrisk <mtk.manpages@googlemail.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-10-16Update Jens Axboe's email in Documentation/*Rob Landley1-1/+1
Jens Axboe's old email address bounces. Signed-off-by: Rob Landley <rob@landley.net> Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
2007-08-22HOWTO: latest lxr url address changedQi Yong1-2/+2
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>
2007-07-18HOWTO: Add the knwon_regression URI to the documentationPaolo Ciarrocchi1-0/+3
We should let everybody know about where the regression list is hosted. The more is known the more it is used. Signed-off-by: Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com> Cc: Li Yang <leoli@freescale.com> Cc: TripleX Chung <xxx.phy@gmail.com> Cc: Maggie Chen <chenqi@beyondsoft.com> Cc: WANG Cong <xiyou.wangcong@gmail.com> Cc: Tsugikazu Shibata <tshibata@ab.jp.nec.com> Cc: IKEDA Munehiro <m-ikeda@ds.jp.nec.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-06-28Documentation/HOWTO: update URLs of git treesStefan Richter1-15/+13
Also, remove outdated 1394 tree and mention MAINTAINERS as pointer to development trees. Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-05-24Revert "HOWTO: bug report addition" (or "HOWTO: mention bughunting")Linus Torvalds1-20/+0
This reverts commit 722385f75efd82d9f480f0765a1e97a4d83cac0d (or commit 3f27100872b21e4cc70d07b96eeb3611b30bce63, it's your choice ;), since the same patch to Documentation/HOWTO got added twice because it just kept applying cleanly. Noted by Qi Yong. Cc: Qi Yong <qiyong@fc-cn.com> Acked-by: Diego Calleja <diegocg@gmail.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-02-07HOWTO: Add a reference to Harbison and SteeleRobert P. J. Day1-0/+1
Add a reference to Harbison and Steele's C book. Signed-off-by: Robert P. J. Day <rpjday@mindspring.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2006-10-18HOWTO: bug report additionDiego Calleja1-0/+20
I suspect that not many people is subscribed to the bugzilla mailing list, not surprising since the URLs doesn't seem to be in the tree :) After fixing my english, I wonder if the following patch could be applied... Signed-off-by: Diego Calleja <diegocg@gmail.com> Acked-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2006-10-01[PATCH] HOWTO: mention bughuntingDiego Calleja1-0/+20
Signed-off-by: Diego Calleja <diegocg@gmail.com> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2006-09-26[PATCH] Document my tree in Documentation/HOWTOAndi Kleen1-1/+2
Signed-off-by: Andi Kleen <ak@suse.de>
2006-04-27[PATCH] Added URI of "linux kernel development process"Paolo Ciarrocchi1-1/+2
Signed-off-by: Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2005-11-18[PATCH] Add HOWTO do kernel development document to the Documentation directoryGreg Kroah-Hartman1-0/+618
Here's a document that describes the process and procedures of how to do Linux kernel development. It has gone through a number of rounds of review on the linux-kernel mailing list, and contains contributions and help from Paolo Ciarrocchi, Randy Dunlap, Gerrit Huizenga, Pat Mochel, Hanna Linder, Kay Sievers, Vojtech Pavlik, Jan Kara, Josh Boyer, Kees Cook, Andrew Morton, Andi Kleen, Vadim Lobanov, Jesper Juhl, Adrian Bunk, Keri Harris, Frans Pop, David A. Wheeler, Junio Hamano, Michael Kerrisk, and Alex Shepard. Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-17 18:42:29 +0000