14 Dec, 2016
7 commits
-
The previous description have been misleading and partially incorrect.
Reported-by: Harsh Jain
Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet -
Remove the documentation reference to crypto_alloc_ablkcipher as the API
function call was removed.Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet -
Add the KPP API documentation to the kernel crypto API Sphinx
documentation. This addition includes the documentation of the
ECDH and DH helpers which are needed to create the approrpiate input
data for the crypto_kpp_set_secret function.Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet -
Keep the cipher API and the request API function documentation in
separate sections.Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet -
Update comments to avoid any complaints from Sphinx during compilation.
Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet -
With the conversion of the documentation to Sphinx, the old DocBook is
now stale.Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet -
With the conversion of the kernel crypto API DocBook to Sphinx, the
monolithic document is broken up into individual documents. The
documentation is unchanged with the exception of a slight reordering to
keep the individual document parts self-contained.Signed-off-by: Stephan Mueller
Signed-off-by: Jonathan Corbet
12 Dec, 2016
1 commit
-
Just prep work to polish and consolidate all the dma-buf related
documenation.Unfortunately I didn't discover a way to both integrate this new file
into the overall toc while keeping it at the current place. Work
around that by moving it into the overall driver-api/index.rst.Cc: linux-doc@vger.kernel.org
Cc: Jonathan Corbet
Cc: Sumit Semwal
Signed-off-by: Daniel Vetter
Signed-off-by: Jonathan Corbet
06 Dec, 2016
8 commits
-
Em Mon, 5 Dec 2016 14:23:01 -0700
Jonathan Corbet escreveu:> On Mon, 5 Dec 2016 09:41:40 -0200
> Mauro Carvalho Chehab wrote:
>
> > So, in order to check it, I wrote a small script that compares the files
> > and directories at Documentation/ with the ones at 00-INDEX.
> >
> > Then, I synchronized the entries, making the script happy.
> >
> > We might think on integrating the script with checkpatch.pl, but, as
> > we should get rid of 00-INDEX, it probably not worth the efforts.
>
> I would agree with that; I don't see the point of keeping those files
> around in the longer term.
>
> I've applied the set. I do have a few quibbles with the final patch that
> I'll send separately, but they're not something to hold this set up for.Jon,
Did a patch fixing the quibbles.
As it seems you didn't push yet the changeset upstream, feel free to
just fold it with patch 5/5 if you prefer so, or to add as a separate
patch at the end of the series.Patch enclosed.
Thanks,
Mauro[PATCH] docs: 00-INDEX: change text related to the building system
Let be clearer on those files related to the build system.
Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
There are a number of files/directories that don't contain
any documentation. They're related to ReST file conversion.As a matter of completeness, since Makefile is also documented
there, add an entry for those files too.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Several entries were moved to a directory; others got simply
removed. Get rid of those entries.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Several directories and individual files don't have entries at
00-INDEX. Add them, using, as reference, the initial text inside
the documentation file(s).Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Instead of having descriptions for individual files inside
the process/ and admin-guide/ documentation, consolidate them
into one entry per directory, just like other descriptions
inside 00-INDEX.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
It is easy to forget adding/removing entries at the
Documentation/00-INDEX file. In a matter of fact, even before
ReST conversion, people use to forget adding things here, as
there are lots of missing stuff out there.Now that we're doing a hard work converting entries to ReST,
and while this hole file is not outdated, it is good to have
some tool that would help to verify that this file is kept
updated.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
scripts/ver_linux has been rewritten as an awk script; update
documentation to reflect this fact.Signed-off-by: Kevin Peng
Signed-off-by: Jonathan Corbet -
Document device links as introduced in v4.10 with commits:
4bdb35506b89 ("driver core: Add a wrapper around
__device_release_driver()")
9ed9895370ae ("driver core: Functional dependencies tracking
support")
8c73b4288496 ("PM / sleep: Make async suspend/resume of devices use
device links")
21d5c57b3726 ("PM / runtime: Use device links")
baa8809f6097 ("PM / runtime: Optimize the use of device links")Signed-off-by: Lukas Wunner
[ jc: Moved from core-api to driver-api ]
Signed-off-by: Jonathan Corbet
02 Dec, 2016
3 commits
-
As complained by Sphinx:
Documentation/core-api/assoc_array.rst:13: WARNING: Enumerated list ends without a blank line; unexpected unindent.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Update kernel-parameters.txt to add Documentation
for powersave=off.Signed-off-by: Balbir Singh
Signed-off-by: Jonathan Corbet -
This corrects a set of spelling mistakes, probably from an
automated conversion.Signed-off-by: Sanjeev Gupta
Signed-off-by: Jonathan Corbet
01 Dec, 2016
14 commits
-
... and move to core-api folder.
Signed-off-by: Silvio Fricke
Signed-off-by: Jonathan Corbet -
... and move to core-api folder.
Signed-off-by: Silvio Fricke
Reviewed-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
... and move to Documentation/core-api folder.
Signed-off-by: Silvio Fricke
Reviewed-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Keeping both rst and in-file documentation in sync can be harsh.
So, simplify the script's internal documntation to a bare minimum,
and add a mention to the ReST file with its full documentation.This way, a quick help is still available at the command line,
while the complete one is maintained at the ReST format.As we won't be using pad2rst anymore, do a cleanup at the ReST
file.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
The builddir prefix was missing on make cleandocs. Fix it.
Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Better organize the media/Makefile, in order to better
split what's related to image conversion from the ones
related to parse-headers.pl.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Instead of keeping both SVG and graphviz files, dynamically
build SVG from its graphviz sources.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
SVG images are scalable, with makes easier to output on
different formats.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
bitmap images don't scale too well. So, replace it by a SVG
image, written in inkscape. I'm using the 2009's temporary
logo.svg image from 8032b526d1a3 ("linux.conf.au 2009: Tuz"),
with a Tasmanian Devil wearing a tux mask.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
The pipeline image was produced from some dot file that has
long missed. Create a pipeline.dot with the graph and convert
it to SVG. As we're planning to add future support for graphviz
graphics, also store the .dot file on the tree, as this will
make easier when we add such Sphinx extension.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Instead of using bitmap images to show the zigzag macroblock
parsing, replace it by a SVG ones, with is scalable.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Use sans-serif font on all documents, split text lines,
ungroup elements, and do other misc cleanups, in order to make
all of them to look better, and to have smaller columns inside
their lines.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Using vectorial graphics provide a better visual. As those images
are originally using a vectorial graphics input at the pdf files,
use them, from an old media tree repository, converting them to SVG.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
30 Nov, 2016
4 commits
-
Convert the tracepoint docbook template to RST and add it to the core-api
manual. No changes to the actual text beyond the mechanical formatting
conversion.Cc: Jason Baron
Cc: William Cohen
Signed-off-by: Jonathan Corbet -
Add the appropriate markup to get the kerneldoc comments out of
lib/debugobjects.c that have never seen the light of day until now.A logical next step, left for the reader at the moment, is to move the
function descriptions *out* of debug-objects.rst and into the kerneldoc
comments themselves.Signed-off-by: Jonathan Corbet
-
A couple of the most minor heading tweaks, otherwise no changes to the text
itself beyond the mechanical conversion.Note that the inclusion of the kerneldoc comments from the source has never
worked, since exported symbols were asked for and none of those functions
are exported to modules. It doesn't work here either :)Cc: Thomas Gleixner
Signed-off-by: Jonathan Corbet -
Put this documentation with the other driver docs and try to keep the top
level reasonably clean.Cc: Johannes Berg
Signed-off-by: Jonathan Corbet
29 Nov, 2016
1 commit
-
The original text was not clear if white space or other harmless patches
should be merged in -rc kernels. The discussion at Kernel Summit said
that we should be more strict about sending regression fixes only.Signed-off-by: Dan Carpenter
Acked-by: Greg Kroah-Hartman
Signed-off-by: Jonathan Corbet
20 Nov, 2016
2 commits
-
The iowait is not reliable by reading from /proc/stat, so this
method to get iowait is not suggested. And we mark it in the
document.Signed-off-by: Cao Jin
Signed-off-by: Chao Fan
Signed-off-by: Jonathan Corbet
