From dc7a12bdfccd94c31f79e294f16f7549bd411b49 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Sun, 14 Apr 2019 15:51:10 -0300 Subject: docs: arm: convert docs to ReST and rename to *.rst Converts ARM the text files to ReST, preparing them to be an architecture book. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab Reviewed-by Corentin Labbe # For sun4i-ss --- Documentation/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index 216dc0e1e6f2..c6934d90363c 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,3 +1,4 @@ + .. The Linux Kernel documentation master file, created by sphinx-quickstart on Fri Feb 12 13:51:46 2016. You can adapt this file completely to your liking, but it should at least -- cgit v1.2.3 From 09fdc957ad0d0ee83c00cd1e0c3a605047f63bf7 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 18 Jun 2019 16:51:34 -0300 Subject: docs: leds: add it to the driver-api book The contents of leds driver docs is messy: it has lots of admin-guide stuff and kernel internal ones, just like other driver subsystems. I'm opting to keep the dir at the same place and just add a link to it. This makes clearer that this require changes. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index c6934d90363c..c4f9610b6167 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -91,6 +91,7 @@ needed). driver-api/index core-api/index + leds/index media/index networking/index input/index -- cgit v1.2.3 From 616b81db2fa757f48895242ea6aaf3c1a1ad22f4 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 18 Jun 2019 17:13:24 -0300 Subject: docs: ioctl: add it to the uAPI guide While 100% of its contents is userspace, let's keep the dir at the same place, as this is a well-known location. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index c4f9610b6167..864daf8805a4 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -56,6 +56,7 @@ the kernel interface as seen by application developers. :maxdepth: 2 userspace-api/index + ioctl/index Introduction to kernel development -- cgit v1.2.3 From 159a5e78bdcabb1f87ee5536182a99a307ae0bac Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 22 Apr 2019 16:10:26 -0300 Subject: docs: add arch doc directories to the index Now that several arch documents were converted to ReST, add their indexes to Documentation/index.rst and remove the :orphan: from them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index 864daf8805a4..a322c8721d13 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -117,7 +117,16 @@ implementation. :maxdepth: 2 sh/index + arm/index + arm64/index + ia64/index + m68k/index + riscv/index + s390/index + sh/index + sparc/index x86/index + xtensa/index Filesystem Documentation ------------------------ -- cgit v1.2.3 From df1b7ce784c220373d202ea9f8bc0c424f2c9f7c Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 18 Jun 2019 17:16:23 -0300 Subject: docs: add some documentation dirs to the driver-api book Those are subsystem docs, with a mix of kABI and user-faced docs. While they're not split, keep the dirs where they are, adding just a pointer to the main index. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index a322c8721d13..dcdaaff71633 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -92,6 +92,10 @@ needed). driver-api/index core-api/index + accounting/index + block/index + hid/index + iio/index leds/index media/index networking/index -- cgit v1.2.3 From c92992fc609fe99d926855eb1945f38ef4ad8e6c Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 22 Apr 2019 16:49:11 -0300 Subject: docs: driver-api: add remaining converted dirs to it There are a number of driver-specific descriptions that contain a mix of userspace and kernelspace documentation. Just like we did with other similar subsystems, add them at the driver-api groupset, but don't move the directories. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index dcdaaff71633..041ffe442960 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -110,6 +110,9 @@ needed). bpf/index usb/index misc-devices/index + mic/index + phy/samsung-usb2 + scheduler/index Architecture-specific documentation ----------------------------------- -- cgit v1.2.3 From 4745dc8abb0a0a9851c07265eea01d844886d5c8 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 27 Jun 2019 16:36:04 -0300 Subject: docs: phy: place documentation under driver-api This subsystem-specific documentation belongs to the driver-api. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index 041ffe442960..dbfec00ba535 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -111,7 +111,6 @@ needed). usb/index misc-devices/index mic/index - phy/samsung-usb2 scheduler/index Architecture-specific documentation -- cgit v1.2.3 From 113094f743fc97559c068ad20fd2808b64f6989d Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 28 Jun 2019 08:36:50 -0300 Subject: docs: add some directories to the main documentation index The contents of those directories were orphaned at the documentation body. While those directories could likely be moved to be inside some guide, I'm opting to just adding their indexes to the main one, removing the :orphan: and adding the SPDX header. For the drivers, the rationale is that the documentation contains a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on separate directories, as we've be doing with similar subsystem-specific docs that were not split yet. For the others, well... I'm too lazy to do the move. Also, it seems to make sense to keep at least some of those at the main dir (like kbuild, for example). In any case, a latter patch could do the move. Signed-off-by: Mauro Carvalho Chehab Acked-by: Bartlomiej Zolnierkiewicz --- Documentation/index.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index dbfec00ba535..0cd4c3901456 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -35,6 +35,7 @@ trying to get it to work optimally on a given system. :maxdepth: 2 admin-guide/index + kbuild/index Firmware-related documentation ------------------------------ @@ -77,6 +78,9 @@ merged much easier. kernel-hacking/index trace/index maintainer/index + fault-injection/index + livepatch/index + Kernel API documentation ------------------------ @@ -94,11 +98,20 @@ needed). core-api/index accounting/index block/index + cdrom/index + ide/index + fb/index + fpga/index hid/index iio/index leds/index media/index + netlabel/index networking/index + pcmcia/index + target/index + timers/index + watchdog/index input/index hwmon/index gpu/index -- cgit v1.2.3 From 4c68060bf6d3eac6e86b995a200eb21b847236da Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 28 Jun 2019 07:29:15 -0300 Subject: docs: locking: add it to the main index The locking directory is part of the Kernel API bookset. Add it to the index file. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index 0cd4c3901456..eb5db850c4ef 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -96,6 +96,7 @@ needed). driver-api/index core-api/index + locking/index accounting/index block/index cdrom/index -- cgit v1.2.3