b21a57636c
dw-xdata-pcie: Fix documentation build warns
...
Fixes documentation build warns related to indentation, text formatting,
and missing reference on toc.
This fix solves the following warnings:
WARNING: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: document isn't included in any toctree
Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/
Fixes: e1181b5bbchttps://lore.kernel.org/r/42ed2d9d27579291dc7cce89c0164bd9255fe337.1618066164.git.gustavo.pimentel@synopsys.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-04-14 19:47:28 +02:00
d181bfe367
Documentation: remove mic/index from misc-devices/index.rst
...
With the recent removal of the misc/mic/ directory, the documentation
build now warns because we forgot about this index file.
Fix that up so that there are no more warnings here.
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Sudeep Dutt <sudeep.dutt@intel.com>
Link: https://lore.kernel.org/r/20201103083408.GA2511903@kroah.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2020-11-04 11:38:32 +01:00
9f70e48e1f
docs: misc-devices/apds990x.txt: convert to ReST format
...
- Adjust title markup;
- Adjust identation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/444743782e5c8b8085d8016c8be3baabe4d23b53.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:09:17 -06:00
0e7ade47bb
docs: misc-devices/bh1770glc.txt: convert to ReST
...
- Adjust document title markup;
- use list markups;
- Adjust identations to display properly at ReST output.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/58ba712524318d03b3196bba33cb409472b4807d.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:09:13 -06:00
433b1b0d75
docs: misc-devices/c2port.txt: convert to ReST format
...
- Use copyright symbol;
- use title markups;
- adjust indentation;
- mark literal blocks as such.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
[jc: reverted |copy| change]
Link: https://lore.kernel.org/r/b3b2f3f58a9a33f9e8526d4fa36bee305ea4da38.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:08:50 -06:00
16a60665cf
docs: misc-devices/pci-endpoint-test.txt: convert to ReST
...
- Use titles markups;
- Adjust identation;
- use literal markup;
- Use the proper notation for footnotes.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d4def59b3e3042208ed44558ddfd96c8753fb88c.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:06:00 -06:00
8a05eb89cb
docs: misc-devices/pci-endpoint-test.txt: convert to ReST
...
- use title markups;
- mark literal blocks.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/1b1f4e5e57fd2065828cecc9d07afbd247349e94.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:05:49 -06:00
3471b9f7e4
docs: misc-devices/spear-pcie-gadget.txt: convert to ReST
...
- Use title/chapter markups;
- Use table markups;
- Mark literal blocks as such;
- Adjust indentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/4f8e129a93d04426ad7dd51f109725c48158a46d.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:05:33 -06:00
16a398d176
doc: misc-device: add uacce to toctree(index)
...
This fixes:
Documentation/misc-devices/uacce.rst: WARNING: document isn't included in any toctree
Signed-off-by: Vitor Massaru Iha <vitor@massaru.org>
Link: https://lore.kernel.org/r/20200430225828.114033-1-vitor@massaru.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-05-05 09:41:59 -06:00
19796c348a
docs: Move Intel Many Integrated Core documentation (mic) under misc-devices
...
It doesn't need to be a top-level chapter.
This patch also updates MAINTAINERS and makes sure the F: lines are
properly sorted.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Link: https://lore.kernel.org/r/20200308211519.8414-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-03-10 11:12:34 -06:00
e6f4c346d3
Docs: misc: xilinx_sdfec: Add documentation
...
Add SD-FEC driver documentation.
Signed-off-by: Derek Kiernan <derek.kiernan@xilinx.com>
Signed-off-by: Dragan Cvetic <dragan.cvetic@xilinx.com>
Link: https://lore.kernel.org/r/1564216438-322406-8-git-send-email-dragan.cvetic@xilinx.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2019-08-15 17:54:38 +02:00
9b5db89ea4
docs: misc-devices: convert files without extension to ReST
...
Those files are also text files. Convert them to ReST and add
to the misc-files index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Link: https://lore.kernel.org/r/b7dc829809673bd8cffe0e7bbe9c9308681c6fe2.1561756511.git.mchehab+samsung@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2019-07-03 21:09:41 +02:00
5591a3075e
Documentation: add ibmvmc to toctree(index) and fix warnings
...
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>
2019-01-14 08:37:17 -07:00
Gustavo Pimentel