Skip to content

Commit

Permalink
Documentation: add ibmvmc to toctree(index) and fix warnings
Browse files Browse the repository at this point in the history
Fix Sphinx warnings in ibmvmc.rst, add an index.rst file in
Documentation/misc-devices/, and insert that index file into the
top-level index file.

Documentation/misc-devices/ibmvmc.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Documentation/misc-devices/ibmvmc.rst:: WARNING: document isn't included in any toctree

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Steven Royer <seroyer@linux.ibm.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
rddunlap authored and Jonathan Corbet committed Jan 14, 2019
1 parent 7fbc258 commit 5591a30
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ needed).
filesystems/index
vm/index
bpf/index
misc-devices/index

Architecture-specific documentation
-----------------------------------
Expand Down
1 change: 1 addition & 0 deletions Documentation/misc-devices/ibmvmc.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GPL-2.0+
======================================================
IBM Virtual Management Channel Kernel Driver (IBMVMC)
======================================================
Expand Down
17 changes: 17 additions & 0 deletions Documentation/misc-devices/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. SPDX-License-Identifier: GPL-2.0
============================================
Assorted Miscellaneous Devices Documentation
============================================

This documentation contains information for assorted devices that do not
fit into other categories.

.. class:: toc-title

Table of contents

.. toctree::
:maxdepth: 2

ibmvmc

0 comments on commit 5591a30

Please sign in to comment.