Skip to content

R
raspberrypi-kernel

openeuler / raspberrypi-kernel

通知 13
Star 1
Fork 0
R
raspberrypi-kernel
切换分支/标签
  1. 06 12月, 2016 3 次提交
  3. 02 12月, 2016 3 次提交
  5. 01 12月, 2016 14 次提交
  7. 30 11月, 2016 4 次提交
  9. 29 11月, 2016 1 次提交
  11. 20 11月, 2016 6 次提交
  13. 19 11月, 2016 2 次提交
  15. 17 11月, 2016 7 次提交
    • J
      kernel-doc: add support for one line inline struct member doc comments · 0c9aa209
      由 Jani Nikula 提交于 
      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: NJani Nikula <jani.nikula@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      0c9aa209
    • B
      docs/completion.txt: drop dangling reference to completions-design.txt · dc92726e
      由 Brian Norris 提交于 
      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: NBrian Norris <briannorris@chromium.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      dc92726e
    • O
      Documentation: convert USB to new format · dd0b38d8
      由 Oliver Neukum 提交于 
      This is a conversion of the USB documentation to the Sphinx format.
No content was altered or reformatted.
Signed-off-by: NOliver <oneukum@suse.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      dd0b38d8
    • M
      Documentation: circular-buffers: use READ_ONCE() · 01e46442
      由 Mark Rutland 提交于 
      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: NMark Rutland <mark.rutland@arm.com>
Acked-by: NDavid Howells <dhowells@redhat.com>
Acked-by: NPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      01e46442
    • M
      Documentation: atomic_ops: use {READ,WRITE}_ONCE() · 47f42122
      由 Mark Rutland 提交于 
      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: NMark 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: NPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      47f42122
    • J
      docs: Add more manuals to the PDF build · 22917b99
      由 Jonathan Corbet 提交于 
      There were a few manuals that weren't being built in PDF format, but
there's no reason not to...
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      22917b99
    • J
      Merge branch 'mauro-pdf' into docs-next · 3ed3e130
      由 Jonathan Corbet 提交于 
      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