21 Sep, 2016
24 commits
-
This one required lots of manual work, for it to be properly
displayed.Signed-off-by: Mauro Carvalho Chehab
-
Do a few changes to make the output look better:
- use bullets on trivial patches list;
- use monotonic font for tools name;
- use :manpage:`foo` for man pages;
- don't put all references to maintainer*html at the same line.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- Change the sections to use ReST markup;
- Add cross-references where needed;
- convert aspas to verbatim text;
- use code block tags;
- make Sphinx happy.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- Change the document title markup to make it on a higher level;
- Add blank lines as needed, to improve the output;
- use italics for the country-code at kernel.org ftp URL.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- use ReST markups for section headers;
- add cross-references to the options;
- mark code blocks;
- a few minor changes to make Sphinx happy.Signed-off-by: Mauro Carvalho Chehab
Acked-by: Greg Kroah-Hartman
Signed-off-by: Jonathan Corbet -
Add markups for it to be properly parsed by Sphinx.
As people browsing this document may not notice that the source
file title is "stable_api_nonsense", I opted to use bold to
the rationale for this document. I also found it better to
add a note when it says that the nonsense applies only to the
kABI/kAPI, and not to uAPI.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Add a name for the document and convert the sections to
ReST markups.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- Convert document name to ReST;
- Convert footnotes;
- Convert sections to ReST format;
- Don't use _foo_, as Sphinx doesn't support underline. Instead,
use bold;
- While here, remove whitespaces at the end of lines.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
There are two places there where there are notes that should
be highlighted. So, use the ReST note markup for such texts.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Sphinx doesn't accept underline markups by purpose.
While there are ways to support underline via CSS, this won't
be portable with non-html outputs.As we want CodingStyle to do emphasis, replace _foo_ by **foo**,
using bold emphasis.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
On Sphinx/ReST notation, ``foo`` means that foo will be will be
marked as inline literal, effectively making it to be presented
as a monospaced font.As we want this document to be parsed by Sphinx, instead of using
"foo", use ``foo`` for the names that are literal, because it is an
usual typographic convention to use monospaced fonts for functions
and language commands on documents, and we're following such
convention on the other ReST books.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- Fix all chapter identation;
- add c blocks where needed;Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
As discussed at linux-doc ML, the best is to keep all documents
backward compatible with Sphinx version 1.2, as it is the latest
version found on some distros like Debian.All books currently support it.
Please notice that, while it mentions the eventual need of
XeLaTex and texlive to build pdf files, this is not a minimal
requirement, as one could just be interested on building html
documents. Also, identifying the minimal requirements for
texlive packages is not trivial, as each distribution seems to
use different criteria on grouping LaTex functionalities.While here, update the current kernel version to 4.x.
Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- Fix chapter identation inconsistencies;
- Convert table to ReST format;
- use the right tag for bullets;
- Fix bold emphasis;
- mark blocks with :: tags;
- use verbatim font for files;
- make Sphinx happySigned-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
This document is old: it is from Kernel v2.6.12 days.
Update it to the current status, and add a reference for the
linux-next tree.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
- use the correct markup to identify each section;
- Add some blank lines for Sphinx to properly interpret
the markups;- Remove a blank space on some paragraphs;
- Fix the verbatim and bold markups;
- Cleanup the remaining errors to make Sphinx happy.
Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
This document is almost compliant with ReST notation, but some
small adjustments are needed to make it parse properly by
Sphinx (mostly, add blank lines where needed).Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Now that the files at Documentation/development-process/
were converted to ReST, make create a book at Sphinx.As we'll have other books related to the development process,
we'll add it as a sub-book.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Now that the documents were converted, rename them to .rst, as
this is needed by the Sphinx build logic.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
This document is on good shape for ReST: all it was needed was
to fix the section markups, add a toctree, convert the tables
and add a few code/quote blocks.While not strictly required, I opted to use lowercase for
the titles, just like the other books that were converted
to Sphinx.Signed-off-by: Mauro Carvalho Chehab
-
As we're about to use those two markups, add them to the
theme style overrride.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Multi-cpu support is useful to improve the performance of kdump in
some cases. So add the description of enable multi-cpu support in
dump-capture kernel.Signed-off-by: Zhou Wenjian
Acked-by: Baoquan He
Acked-by: Xunlei Pang
Signed-off-by: Jonathan Corbet -
nr_cpus can help to save memory. So we should remind user of it.
Signed-off-by: Zhou Wenjian
Acked-by: Baoquan He
Acked-by: Xunlei Pang
Signed-off-by: Jonathan Corbet -
Fix a type in example variable name.
Signed-off-by: Andrey Smirnov
Signed-off-by: Jonathan Corbet
17 Sep, 2016
3 commits
-
This short series convers device-drivers.tmpl into the RST format, splits
it up, and sets up the result under Documentation/driver-api/. For added
fun, I've taken one top-level file (hsi.txt) and folded it into the
document as a way of showing the direction I'm thinking I would like things
to go. There is plenty more of this sort of work that could be done, to
say the least - this is just a beginning!The formatted results can be seen at:
http://static.lwn.net/kerneldoc/driver-api/index.html
As part of the long-term task to turn Documentation/ into less of a horror
movie, I'd like to collect documentation of the driver-specific API here.
Arguably gpu/ and the media API stuff should eventually move here, though
we can discuss the color of that particular shed some other day.
Meanwhile, I'd appreciate comments on the general idea. -
No need to be be, just be should be sufficient.
Signed-off-by: Laurent Navet
Signed-off-by: Jonathan Corbet -
So don't mention it.
Signed-off-by: Christoph Hellwig
Signed-off-by: Jonathan Corbet
16 Sep, 2016
3 commits
-
Handle signatures of function-like macros well. Don't try to deduce
arguments types of function-like macros.Signed-off-by: Markus Heiser
Signed-off-by: Jonathan Corbet -
The self.indexnode's tuple has changed in sphinx version 1.4, from a
former 4 element tuple to a 5 element tuple.https://github.com/sphinx-doc/sphinx/commit/e6a5a3a92e938fcd75866b4227db9e0524d58f7c
Signed-off-by: Markus Heiser
Signed-off-by: Jonathan Corbet -
Fixed a -> an typo.
Signed-off-by: Robert Foss
Acked-by: Kees Cook
Signed-off-by: Jonathan Corbet
06 Sep, 2016
8 commits
-
This is the driver API document, so the internal stuff is just noise here.
Signed-off-by: Jonathan Corbet
-
It never made sense to keep these documents together; move each into its
own file.Drop the section numbering on hsi.txt on its way to its own file.
Suggested-by: Sebastian Reichel
Signed-off-by: Jonathan Corbet -
The HSI subsystem documentation was split across hsi.txt and the
device-drivers docbook. Now that the latter has been converted to Sphinx,
pull in the HSI document so that it's all in one place.Acked-by: Sebastian Reichel
Signed-off-by: Jonathan Corbet -
Add yet another regex to kernel-doc to trap @param() references separately
and not produce corrupt RST markup.Signed-off-by: Jonathan Corbet
-
As far as I can tell, the handling of "..." arguments has never worked
right, so any documentation provided was ignored in favor of "variable
arguments." This makes kernel-doc handle "@...:" as documented. It does
*not* fix spots in kerneldoc comments that don't follow that convention,
but they are no more broken than before.Signed-off-by: Jonathan Corbet
-
This is a trivial fix to correct upper bound addresses to always be
inclusive. Previously, the majority of ranges specified were inclusive with a
small minority specifying an exclusive upper bound. This patch fixes this
inconsistency.Signed-off-by: Lorenzo Stoakes
Signed-off-by: Jonathan Corbet -
The driver that used the 'nodisconnect' parameter was removed in
commit 565bae6a4a8f ("[SCSI] 53c7xx: kill driver"). Related documentation
was cleaned up in commit f37a7238d379 ("[SCSI] 53c7xx: fix removal
fallout"), except for the remaining two mentions that are removed here.Signed-off-by: Finn Thain
Reviewed-by: Geert Uytterhoeven
Signed-off-by: Jonathan Corbet -
- The guide currently says to pad the structure to a multiple of
64-bits. This is not necessary in cases where the structure contains
no 64-bit types. Clarify this concept to avoid unnecessary padding.
- When using __u64 to hold user pointers, blindly trying to do a cast to
a void __user * may generate a warning on 32-bit systems about a cast
from an integer to a pointer of different size. There is a macro to
deal with this which hides an ugly double cast. Add a reference to
this macro.Signed-off-by: Laura Abbott
Acked-by: Arnd Bergmann
Signed-off-by: Jonathan Corbet
01 Sep, 2016
2 commits
-
To build only the PDF of the media folder run::
make SPHINXDIRS=media pdfdocs
Signed-off-by: Markus Heiser
Signed-off-by: Jonathan Corbet -
This extends the method to build only sub-folders to the targets
"latexdocs" and "pdfdocs". To do so, a conf.py in the sub-folder is
required, where the latex_documents of the sub-folder are
defined. E.g. to build only gpu's PDF add the following to the
Documentation/gpu/conf.py::+latex_documents = [
+ ("index", "gpu.tex", "Linux GPU Driver Developer's Guide",
+ "The kernel development community", "manual"),
+]and run:
make SPHINXDIRS=gpu pdfdocs
Signed-off-by: Markus Heiser
Signed-off-by: Jonathan Corbet