Skip to content

Commit

Permalink
docs: add some directories to the main documentation index
Browse files Browse the repository at this point in the history
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 <[email protected]>
Acked-by: Bartlomiej Zolnierkiewicz <[email protected]>
  • Loading branch information
mchehab committed Jul 15, 2019
1 parent 7e04273 commit 113094f
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Documentation/cdrom/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
=====
cdrom
Expand Down
2 changes: 1 addition & 1 deletion Documentation/fault-injection/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
===============
fault-injection
Expand Down
2 changes: 1 addition & 1 deletion Documentation/fb/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
============
Frame Buffer
Expand Down
2 changes: 1 addition & 1 deletion Documentation/fpga/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
====
fpga
Expand Down
2 changes: 1 addition & 1 deletion Documentation/ide/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
==================================
Integrated Drive Electronics (IDE)
Expand Down
13 changes: 13 additions & 0 deletions Documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------------------
Expand Down Expand Up @@ -77,6 +78,9 @@ merged much easier.
kernel-hacking/index
trace/index
maintainer/index
fault-injection/index
livepatch/index


Kernel API documentation
------------------------
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Documentation/kbuild/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
===================
Kernel Build System
Expand Down
2 changes: 1 addition & 1 deletion Documentation/livepatch/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
===================
Kernel Livepatching
Expand Down
2 changes: 1 addition & 1 deletion Documentation/netlabel/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
========
NetLabel
Expand Down
2 changes: 1 addition & 1 deletion Documentation/pcmcia/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
======
pcmcia
Expand Down
2 changes: 1 addition & 1 deletion Documentation/target/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
==================
TCM Virtual Device
Expand Down
2 changes: 1 addition & 1 deletion Documentation/timers/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
======
timers
Expand Down
2 changes: 1 addition & 1 deletion Documentation/watchdog/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
======================
Linux Watchdog Support
Expand Down

0 comments on commit 113094f

Please sign in to comment.