kernel/linux
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/ synced 2026-09-26 18:16:26 +00:00
Code Issues Releases Packages Activity
linux/Documentation/process/kernel-docs.rst

620 lines
24 KiB
Raw Permalink Normal View History

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-19 08:07:56 -03:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt update. Signed-off-by: James Nelson <james4765@gmail.com> Signed-off-by: Adrian Bunk <bunk@stusta.de>
2007-02-17 20:15:38 +01:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: move in-kernel docs 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-20 08:36:40 -03:00
docs: update old references for DocBook from the documentation DocBook is mentioned several times at the documentation. Update the obsolete references from it at the DocBook. Acked-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-05-14 11:50:11 -03:00
Documentation/kernel-docs.txt: move in-kernel docs 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-20 08:36:40 -03:00
Documentation/kernel-docs.txt: some improvements on the ReST output - 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-20 08:36:35 -03:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Fix broken link in Documentation/process/kernel-docs.rst Kernel Glossary has moved from /Glossary to /KernelGlossary on kernelnewbies.org. This patch corrects this link. Signed-off-by: Grigory Shipunov <mail@oxapentane.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-01-30 15:58:06 +03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt: Add dates for online docs 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-20 08:36:42 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: some improvements on the ReST output - 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-20 08:36:35 -03:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: add two published books 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-20 08:36:38 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: add two published books 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-20 08:36:38 -03:00
Documentation/kernel-docs.txt: adjust LDD references - 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-20 08:36:36 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: sort books per publication date 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-20 08:36:37 -03:00
Documentation/kernel-docs.txt: Add 4 paper/book references 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-20 08:36:33 -03:00
Documentation/kernel-docs.txt: some improvements on the ReST output - 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-20 08:36:35 -03:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces 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-20 08:36:34 -03:00
Documentation/kernel-docs.txt: convert it to ReST markup This one required lots of manual work, for it to be properly displayed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-19 08:07:55 -03:00
Documentation/kernel-docs.txt: reorder based on timestamp 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-20 08:36:43 -03:00
Documentation/kernel-docs.txt: some improvements on the ReST output - 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-20 08:36:35 -03:00