Commit graph android_kernel_sony_sdm845/Documentation/HOWTO
Message SHA1
docs: Clean up bare :: lines
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>

Jonathan Corbet   commited 2016-09-20 18:46:36 -06:00
1b49ecf2f3
Documentation/HOWTO: adjust external link references
- 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>

Mauro Carvalho Chehab   authored and   Jonathan Corbet   commited 2016-09-20 18:41:36 -06:00
f1eebe92c2
Documentation/HOWTO: improve some markups to make it visually better
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>

Mauro Carvalho Chehab   authored and   Jonathan Corbet   commited 2016-09-20 18:41:27 -06:00
34fed7e7e0
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>

Mauro Carvalho Chehab   authored and   Jonathan Corbet   commited 2016-09-20 18:41:22 -06:00
43fb67a525
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>

Mauro Carvalho Chehab   authored and   Jonathan Corbet   commited 2016-09-20 18:41:04 -06:00
609d99a3b7
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>

Mauro Carvalho Chehab   authored and   Jonathan Corbet   commited 2016-09-20 18:34:16 -06:00
022e04d6f5
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>

Philippe Loctaux   authored and   Jonathan Corbet   commited 2016-03-09 15:30:03 -07:00
ce65508182
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>

Peter Loeffler   authored and   Jonathan Corbet   commited 2016-02-10 13:19:48 -07:00
5645a717c6
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>

Doug Smythies   authored and   Jonathan Corbet   commited 2015-12-10 11:19:35 -07:00
1d12554f0a
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>

Mario Carrillo   authored and   Jonathan Corbet   commited 2015-08-24 11:28:17 -06:00
e4144fe5d4
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>

Jim Davis   authored and   Jonathan Corbet   commited 2014-10-28 09:06:11 -04:00
ace80793d1
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>

SeongJae Park   authored and   Greg Kroah-Hartman   commited 2013-12-10 23:09:08 -08:00
937d9f5511
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>

Ben Minerds   authored and   Greg Kroah-Hartman   commited 2013-06-03 14:22:57 -07:00
17c057a35f
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>

Cristian Stoica   authored and   Jiri Kosina   commited 2012-12-10 15:54:27 +01:00
106f9d9337
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>

Kees Cook   authored and   Greg Kroah-Hartman   commited 2012-04-19 19:13:08 -07:00
591bfc6bf9
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>

Joe Perches   authored and   Greg Kroah-Hartman   commited 2011-12-12 14:14:31 -08:00
2eb7f204db
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>

Harry Wei   authored and   Linus Torvalds   commited 2011-05-23 15:14:11 -07:00
8208266060
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>

Justin P. Mattock   authored and   Jiri Kosina   commited 2010-08-04 15:21:40 +02:00
0ea6e61122
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>

Randy Dunlap   authored and   Greg Kroah-Hartman   commited 2010-04-22 15:24:56 -07:00
e234ebf788
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>

Stefan Richter   authored and   Greg Kroah-Hartman   commited 2010-03-07 17:04:49 -08:00
c607cf0c20
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>

FD Cami   authored and   Linus Torvalds   commited 2008-10-16 11:21:32 -07:00
2223c65103
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>

Michael Kerrisk   authored and   Linus Torvalds   commited 2008-10-03 18:22:18 -07:00
09b05f5ee0
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>

Tsugikazu Shibata   authored and   Greg Kroah-Hartman   commited 2008-07-21 21:54:59 -07:00
43166141f7
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>

Jiri Pirko   authored and   Linus Torvalds   commited 2008-07-13 12:51:18 -07:00
0302c01b4b
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>

Jonathan Corbet   commited 2008-04-25 11:23:56 -06:00
0fe8a3ce73
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>

Michael Kerrisk   authored and   Linus Torvalds   commited 2007-10-17 08:43:01 -07:00
1d7f502380
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>

Rob Landley   authored and   Jens Axboe   commited 2007-10-16 09:59:55 +02:00
26bbb29a2a
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>

Qi Yong   authored and   Greg Kroah-Hartman   commited 2007-08-22 14:35:35 -07:00
4db29c1764
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>

Paolo Ciarrocchi   authored and   Greg Kroah-Hartman   commited 2007-07-18 15:49:50 -07:00
be38849436
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>

Stefan Richter   authored and   Linus Torvalds   commited 2007-06-28 11:34:54 -07:00
8a465c3239
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>

Linus Torvalds   commited 2007-05-24 08:50:39 -07:00
1a93fa86bf
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>

Robert P. J. Day   authored and   Greg Kroah-Hartman   commited 2007-02-07 10:37:13 -08:00
4de0ca8132
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>

Diego Calleja   authored and   Greg Kroah-Hartman   commited 2006-10-18 12:49:54 -07:00
722385f75e
[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>

Diego Calleja   authored and   Linus Torvalds   commited 2006-10-01 00:39:22 -07:00
3f27100872
[PATCH] Document my tree in Documentation/HOWTO
Signed-off-by: Andi Kleen <ak@suse.de>

Andi Kleen   commited 2006-09-26 10:52:38 +02:00
027a51cef3
[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>

Paolo Ciarrocchi   authored and   Greg Kroah-Hartman   commited 2006-04-27 13:08:57 -07:00
5bd982ed0f
[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>

Greg Kroah-Hartman   authored and   Linus Torvalds   commited 2005-11-18 10:51:21 -08:00
d36cc9d081