summaryrefslogtreecommitdiff
path: root/Documentation/kernel-docs.txt
AgeCommit message (Collapse)AuthorFilesLines
2016-09-21Documentation/kernel-docs.txt: reorder based on timestampMauro Carvalho Chehab1-258/+262
Reorder the on-line documents based on their timestamp or copyright notes. More updated documents come first. While here, add the number of pages for POSIX4 document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-21Documentation/kernel-docs.txt: Add dates for online docsMauro Carvalho Chehab1-9/+43
It is a way better to have a timestamp to help identifying when something is too old. So, retrieve the dates marked on the existing documents. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-21Documentation/kernel-docs.txt: get rid of broken docsMauro Carvalho Chehab1-41/+0
There are still some broken docs: the URLs point to somewhere, however, the texts are not there anymore. I was able to find the texts on other URLs for some of those, but they're all too old. So, just get rid of them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: move in-kernel docsMauro Carvalho Chehab1-44/+47
There are three places where it mentions in-kernel docs. Move them to a separate topic. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: remove more legacy referencesMauro Carvalho Chehab1-17/+0
The Linux Kernel - This book is for Kernel 2.0.33 Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: add two published booksMauro Carvalho Chehab1-0/+16
Add two books from my own bookshelf. I found them useful by the time I bought; so it could be useful to others ;) Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: sort books per publication dateMauro Carvalho Chehab1-44/+46
Instead of using a random order, place the books on publication date, from the newest to the oldest. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-21Documentation/kernel-docs.txt: adjust LDD referencesMauro Carvalho Chehab1-29/+2
- remove LDD versions 1 and 2, as there's already an entry for LDD3; - add a link between LDD online and published entries. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: some improvements on the ReST outputMauro Carvalho Chehab1-8/+7
- Use lower case for sections, as this is the standard used on the other ReST files; - The latest version of this document is at the Kernel source, and not at the listed URL. So, move it to the end of the doc. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: Consistent indenting: 4 spacesRichard Sailer1-626/+626
This introduces a consistent indenting of 4 spaces for all lists. [mchehab@s-opensource.com: rebased to apply before rename] Signed-off-by: Richard Sailer <richard@weltraumpflege.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-21Documentation/kernel-docs.txt: Add 4 paper/book referencesRichard Sailer1-0/+45
Background/Reasoning: Books: ------ * Linux Kernel Networking by Rami Rosen While some parts are quite short and could be more carefully explained it's still a good recomendation for understanding linux kernel networking, (IMHO) * Linux Treiber entwickeln: It sure is a drawback that this is a german book. But it's quite recent, well structured and there are also other non-english (spanish) books/papers in this list. Papers: ------- * On Submitting kernel Patches Contains 2 case studies of bigger patch sets and how (or how not) they were merged. I found it helpful * Tracing the Way of Data in a TCP Connection through the Linux Kernel Since this was written by me this inclusion may be a bit biased :p Neitherless I think this gives a good introduction on understanding/exploring linux internals using ftrace and an overview of Linux TCP internals. [mchehab@s-opensource.com: rebased to apply before rename] Signed-off-by: Richard Sailer <richard@weltraumpflege.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-21Documentation/kernel-docs.txt: Improve layouting of book listRichard Sailer1-43/+43
The dots at the ends of the list elements introduced unnecesarry newlines in the "compiled" document. While this was not "mission critical" it's not nice to look at either. [mchehab@s-opensource.com: rebased to apply before rename] Signed-off-by: Richard Sailer <richard@weltraumpflege.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-09-21Documentation/kernel-docs.txt: Remove offline or outdated entriesRichard Sailer1-158/+1
This removes all dead links to online docs which are dead according to Jon and Mauro in https://lkml.kernel.org/r/20160916182849.2a7101ea () vento ! lan Additionally some references to very old articles refering to linux 2.2 and 2.0 are deleted. [mchehab@s-opensource.com: rebased to apply before rename] Signed-off-by: Richard Sailer <richard@weltraumpflege.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-21Documentation/HOWTO: add cross-references to other documentsMauro Carvalho Chehab1-0/+2
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-21Documentation/kernel-docs.txt: convert it to ReST markupMauro Carvalho Chehab1-728/+786
This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-04-16Documentation: update Michael K. Johnson's workLuis de Bethencourt1-8/+8
The URL for "Writing Linux Device Drivers" hasn't been available in some time. Updating the entry to Michael K. Johnson's "Linux Kernel Hackers' Guide" Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-03-31Documentation: update URLs for Richard Gooch's articlesLuis de Bethencourt1-2/+2
Current URL for "Kernel API changes from 2.0 to 2.2" hasn't been available for some time, updating. The second article about changes from 2.2 to 2.4 is missing a URL, adding it. Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-03-31Documentation: update URL of Analysis of the Ext2fs structureLuis de Bethencourt1-1/+1
The current URL has been down for some time, updating it to a working one. Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-03-31Documentation: add Linux Kernel Development bookLuis de Bethencourt1-0/+7
The Linux Kernel Development book by Robert Love has been recommended to me by multiple kernel hackers. Worth having in the list of books in kernel-docs.txt for newbies looking for good learning resources. Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-01-12Documentation: translations: update linux cross reference linkSeongJae Park1-1/+1
The old link to source code cross reference does not work now. Though the link has updated by commit 1d12554f0abbc7d17dce8d1b7b25f4e27555e6d7 ("Documentation: HOWTO: update code cross reference link"), there are few obsolete links yet. This commit update them. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-10-12kernel-docs.txt: update kernelnewbies referenceRichard Sailer1-7/+7
The #kernelnewbies irc channel is no longer hosted on irc.openprojects.net but on irc.oftc.net. Removed pointer to different regional servers since oftc already uses geo-IP load balancing. The "description" quoted from the website no longer exists, therefore removed the reference, quotes and carets. The paragraph also contains a pointer to the kernelnewbies.org website. Therefore changing the title to: "Kernel Newbies IRC Channel and Website." Signed-off-by: Richard Sailer <richard@weltraumpflege.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2011-09-27doc: fix broken referencesPaul Bolle1-2/+2
There are numerous broken references to Documentation files (in other Documentation files, in comments, etc.). These broken references are caused by typo's in the references, and by renames or removals of the Documentation files. Some broken references are simply odd. Fix these broken references, sometimes by dropping the irrelevant text they were part of. Signed-off-by: Paul Bolle <pebolle@tiscali.nl> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2011-08-14Documentation: drop Linux Source Driver from kernel-docs referencesLuis de Bethencourt1-11/+0
Dropping LSD (Linux Source Driver) since it hasn't been available for a long time. Signed-off-by: Luis de Bethencourt <luis@debethencourt.com> Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-01-06Documentation: update kernel-docs.txtNicolas Kaiser1-25/+2
Fixed typos, and removed duplicated entries. Signed-off-by: Nicolas Kaiser <nikai@nikai.net> 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-21/+18
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-23Documentation/: it's -> its where appropriateFrancis Galiegue1-5/+5
Fix obvious cases of "it's" being used when "its" was meant. Signed-off-by: Francis Galiegue <fgaliegue@gmail.com> Acked-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2008-06-06doc: update to URL and status of kernel-docs.txt entryPaul Jackson1-4/+4
Update status and URL for the "Gary's Encyclopedia" entry. Signed-off-by: Paul Jackson <pj@sgi.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-10-20typo fixesMatt LaPlante1-2/+2
Most of these fixes were already submitted for old kernel versions, and were approved, but for some reason they never made it into the releases. Because this is a consolidation of a couple old missed patches, it touches both Kconfigs and documentation texts. Signed-off-by: Matt LaPlante <kernel1@cyberdogtech.com> Acked-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Adrian Bunk <bunk@kernel.org>
2007-05-09documentation: convert the Documentation directory to UTF-8John Anthony Kazos Jr1-1/+1
Convert files within the Documentation directory to UTF-8. Adrian Bunk: small additional fixes Signed-off-by: John Anthony Kazos Jr. <jakj@j-a-k-j.com> Signed-off-by: Adrian Bunk <bunk@stusta.de>
2007-02-17Documentation/kernel-docs.txt update.James Nelson1-136/+121
Signed-off-by: James Nelson <james4765@gmail.com> Signed-off-by: Adrian Bunk <bunk@stusta.de>
2006-10-04remove mentionings of devfs in documentationAdrian Bunk1-11/+0
Now that devfs is removed, there's no longer any need to document how to do this or that with devfs. This patch includes some improvements by Joe Perches. Signed-off-by: Adrian Bunk <bunk@stusta.de>
2005-11-22[PATCH] kernel Doc/ URL correctionsRandy Dunlap1-25/+35
Correct lots of URLs in Documentation/ Also a few minor whitespace cleanups and typo/spello fixes. Sadly there are still a lot of bad URLs remaining. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-04-17Linux-2.6.12-rc2v2.6.12-rc2Linus Torvalds1-0/+777
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!