Skip to content

L
linux
Switch branch/tag
  1. 05 Dec, 2016 1 commit
  3. 01 Dec, 2016 17 commits
  5. 29 Nov, 2016 5 commits
  7. 19 Nov, 2016 6 commits
  9. 18 Nov, 2016 2 commits
  11. 16 Nov, 2016 9 commits
    • Jani Nikula's avatar
      kernel-doc: add support for one line inline struct member doc comments · 0c9aa209
      Jani Nikula authored 
      kernel-doc supports documenting struct members "inline" since
a4c6ebed ("scripts/kernel-doc Allow struct arguments documentation
in struct body"). This requires the inline kernel-doc comments to have
the opening and closing comment markers (/** and */ respectively) on
lines of their own, even for short comments. For example:

	/**
	 * struct foo - struct documentation
	 */
	struct foo {
		/**
		 * @bar: member documentation
		 */
		int bar;
	};

Add support for one line inline comments:

	/**
	 * struct foo - struct documentation
	 */
	struct foo {
		/** @bar: member documentation */
		int bar;
	};

Note that mixing of the two in one doc comment is not allowed; either
both comment markers must be on lines of their own, or both must be on
the one line. This limitation keeps both the comments more uniform, and
kernel-doc less complicated.

Cc: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      0c9aa209
    • Brian Norris's avatar
      docs/completion.txt: drop dangling reference to completions-design.txt · dc92726e
      Brian Norris authored 
      Per the original author, the proposed document was never deemed
necessary, and the important bits got merged into completion.txt. Let's
just stop confusing readers by pointing at a nonexistent doc.
Signed-off-by: default avatarBrian Norris <briannorris@chromium.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      dc92726e
    • Oliver Neukum's avatar
      Documentation: convert USB to new format · dd0b38d8
      Oliver Neukum authored 
      This is a conversion of the USB documentation to the Sphinx format.
No content was altered or reformatted.
Signed-off-by: default avatarOliver <oneukum@suse.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      dd0b38d8
    • Mark Rutland's avatar
      Documentation: circular-buffers: use READ_ONCE() · 01e46442
      Mark Rutland authored 
      While the {READ,WRITE}_ONCE() macros should be used in preference to
ACCESS_ONCE(), the circular buffer documentation uses the latter
exclusively.

To point people in the right direction, and as a step towards the
eventual removal of ACCESS_ONCE(), update the documentation to use
READ_ONCE(), as ACCESS_ONCE() is only used in a reader context in the
circular buffer documentation.
Signed-off-by: default avatarMark Rutland <mark.rutland@arm.com>
Acked-by: default avatarDavid Howells <dhowells@redhat.com>
Acked-by: default avatarPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      01e46442
    • Mark Rutland's avatar
      Documentation: atomic_ops: use {READ,WRITE}_ONCE() · 47f42122
      Mark Rutland authored 
      While the {READ,WRITE}_ONCE() macros should be used in preference to
ACCESS_ONCE(), the atomic documentation uses the latter exclusively.

To point people in the right direction, and as a step towards the
eventual removal of ACCESS_ONCE(), update the documentation to use the
{READ,WRITE}_ONCE() macros as appropriate.
Signed-off-by: default avatarMark Rutland <mark.rutland@arm.com>
Cc: Boqun Feng <boqun.feng@gmail.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Will Deacon <will.deacon@arm.com>
Acked-by: default avatarPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      47f42122
    • Jonathan Corbet's avatar
      docs: Add more manuals to the PDF build · 22917b99
      Jonathan Corbet authored 
      There were a few manuals that weren't being built in PDF format, but
there's no reason not to...
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      22917b99
    • Jonathan Corbet's avatar
      Merge branch 'mauro-pdf' into docs-next · 3ed3e130
      Jonathan Corbet authored 
      Mauro says:

This series address a series of errors during PDF generation from
media documentation.

The first patch fixes the late redefinition of a LaTeX command at the
Sphinx LaTeX style that causes build to break when some cross-references
are used.

The next two patches fix PDF output issues with subdev-formats.rst.

The next 3 patches fix image includes and their output for PDF.

It is aligned with Linus request of not having binary-generated images
from their SVG source codes.

I still intend to move the remaing PNG images to vectorial ones (SVG),
as image scale works better, but this will require some additional work.
When done, I'll submit as a separate patch series.

It should also be noticed that the last patch violates the output dir,
when make is used with "O=some_dir", as Sphinx doesn't accept
image files outside the source directory. We'll likely need some Sphinx
extension in order to fix it, but at least with this series (plus Jani Nikola's
PDF fix series), the PDF output should work fine again.

[jc: added a commit fixing up a "make cleandocs" warning]
      3ed3e130
    • Jonathan Corbet's avatar
      docs: Avoid warning on cleandocs · c54b6b37
      Jonathan Corbet authored 
      Recent Makefile changes added an rm command without the requisite "-f",
leading to warnings if the files do not exist.  Make it be quiet again.
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      c54b6b37
    • Mauro Carvalho Chehab's avatar
      docs-rst: auto-generate PDF image files · 15a04d4e
      Mauro Carvalho Chehab authored 
      The PDF files that contain media images were actually generated
offline from their SVG or PNG source files.

Sphinx can handle PNG sources automatially. So, let's just
drop their PDF counterparts.

For SVG, however, Sphinx doesn't produce the right tags to
use the TexLive SVG support. Also, the SVG support is done via
shell execution, with is not nice.

So, while we don't have any support for SVG inside Sphinx
core or as an extension, move the logic to build them to Makefile,
producing the PDF images on runtime.

NOTE: due to the way Sphinx works, the PDF images should be
generated inside the Kernel source tree, as otherwise Sphinx
won't find it, not obeying what's specified by "O=" makefile
parameter.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      15a04d4e
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7