Commit Graph

34 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab 43fb67a525 Documentation/HOWTO: update information about generating documentation
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-20 18:41:22 -06:00
Mauro Carvalho Chehab 609d99a3b7 Documentation/HOWTO: add cross-references to other documents
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-20 18:41:04 -06:00
Mauro Carvalho Chehab 022e04d6f5 Documentation/HOWTO: convert to ReST notation
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-09-20 18:34:16 -06:00
Philippe Loctaux ce65508182 Documentation: Howto: Fixed subtitles style
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-03-09 15:30:03 -07:00
Peter Loeffler 5645a717c6 Documentation: HOWTO: remove obsolete info about regression postings
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>
2016-02-10 13:19:48 -07:00
Doug Smythies 1d12554f0a Documentation: HOWTO: update code cross reference link
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-12-10 11:19:35 -07:00
Mario Carrillo e4144fe5d4 docs: update HOWTO for 3.x -> 4.x versioning
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>
2015-08-24 11:28:17 -06:00
Jim Davis ace80793d1 Documentation: remove outdated references to the linux-next wiki
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>
2014-10-28 09:06:11 -04:00
SeongJae Park 937d9f5511 Documentation: HOWTO: Update broken links to tpp
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-12-10 23:09:08 -08:00
Ben Minerds 17c057a35f Documentation: Updated broken link in HOWTO
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>
2013-06-03 14:22:57 -07:00
Cristian Stoica 106f9d9337 HOWTO: fix double words typo
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-12-10 15:54:27 +01:00
Kees Cook 591bfc6bf9 docs: update HOWTO for 2.6.x -> 3.x versioning
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>
2012-04-19 19:13:08 -07:00
Joe Perches 2eb7f204db Documentation: Update stable address
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-12-12 14:14:31 -08:00
Harry Wei 8208266060 Documentation: update LXR web link
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>
2011-05-23 15:14:11 -07:00
Justin P. Mattock 0ea6e61122 Documentation: update broken web addresses.
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-08-04 15:21:40 +02:00
Randy Dunlap e234ebf788 Documentation/HOWTO: update git home URL
Update git home page info.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2010-04-22 15:24:56 -07:00
Stefan Richter c607cf0c20 HOWTO: Updates on subsystem trees, patchwork, -next (vs. -mm)
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>
2010-03-07 17:04:49 -08:00
FD Cami 2223c65103 Remove Andrew Morton's http://www.zip.com.au/~akpm/
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-16 11:21:32 -07:00
Michael Kerrisk 09b05f5ee0 Documentation/HOWTO: info about interface changes should CC linux-api@vger
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-10-03 18:22:18 -07:00
Tsugikazu Shibata 43166141f7 HOWTO: change email addresses of James in HOWTO
Signed-off-by: Tsugikazu Shibata <tshibata@ab.jp.nec.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-07-21 21:54:59 -07:00
Jiri Pirko 0302c01b4b Documentation/HOWTO: correct wrong kernel bugzilla FAQ URL
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-07-13 12:51:18 -07:00
Jonathan Corbet 0fe8a3ce73 Various fixes to Documentation/HOWTO
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>
2008-04-25 11:23:56 -06:00
Michael Kerrisk 1d7f502380 Change man-pages maintainer address
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-17 08:43:01 -07:00
Rob Landley 26bbb29a2a Update Jens Axboe's email in Documentation/*
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-10-16 09:59:55 +02:00
Qi Yong 4db29c1764 HOWTO: latest lxr url address changed
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-08-22 14:35:35 -07:00
Paolo Ciarrocchi be38849436 HOWTO: Add the knwon_regression URI to the documentation
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-07-18 15:49:50 -07:00
Stefan Richter 8a465c3239 Documentation/HOWTO: update URLs of git trees
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-06-28 11:34:54 -07:00
Linus Torvalds 1a93fa86bf Revert "HOWTO: bug report addition" (or "HOWTO: mention bughunting")
This reverts commit 722385f75e (or commit
3f27100872, 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-05-24 08:50:39 -07:00
Robert P. J. Day 4de0ca8132 HOWTO: Add a reference to Harbison and Steele
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>
2007-02-07 10:37:13 -08:00
Diego Calleja 722385f75e HOWTO: bug report addition
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-18 12:49:54 -07:00
Diego Calleja 3f27100872 [PATCH] HOWTO: mention bughunting
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-10-01 00:39:22 -07:00
Andi Kleen 027a51cef3 [PATCH] Document my tree in Documentation/HOWTO
Signed-off-by: Andi Kleen <ak@suse.de>
2006-09-26 10:52:38 +02:00
Paolo Ciarrocchi 5bd982ed0f [PATCH] Added URI of "linux kernel development process"
Signed-off-by: Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2006-04-27 13:08:57 -07:00
Greg Kroah-Hartman d36cc9d081 [PATCH] Add HOWTO do kernel development document to the Documentation directory
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>
2005-11-18 10:51:21 -08:00