davidlt/kernel-ark
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Clone of https://gitlab.com/cki-project/kernel-ark
633,367 Commits 169 Branches 650 Tags 3.4 GiB
C 97.1%
Assembly 1.2%
C++ 0.6%
Shell 0.4%
Makefile 0.3%
Other 0.2%
0c9aa20957
Go to file
Jani Nikula 0c9aa20957 kernel-doc: add support for one line inline struct member doc comments 
kernel-doc supports documenting struct members "inline" since
a4c6ebede2 ("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: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-16 16:30:27 -07:00
arch docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
block This adds a new gcc plugin named "latent_entropy". It is designed to 2016-10-15 10:03:15 -07:00
certs certs: Add a secondary system keyring that can be added to dynamically 2016-04-11 22:48:09 +01:00
crypto kthread: kthread worker API cleanup 2016-10-11 15:06:33 -07:00
Documentation docs/completion.txt: drop dangling reference to completions-design.txt 2016-11-16 16:27:50 -07:00
drivers docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
firmware WHENCE: use https://linuxtv.org for LinuxTV URLs 2015-12-04 10:35:11 -02:00
fs docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
include workqueue: kerneldocify workqueue_attrs 2016-10-28 10:54:32 -06:00
init docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
ipc ipc/sem.c: add cond_resched in exit_sme 2016-10-11 15:06:33 -07:00
kernel This adds a new gcc plugin named "latent_entropy". It is designed to 2016-10-15 10:03:15 -07:00
lib docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
mm This adds a new gcc plugin named "latent_entropy". It is designed to 2016-10-15 10:03:15 -07:00
net This adds a new gcc plugin named "latent_entropy". It is designed to 2016-10-15 10:03:15 -07:00
samples linux-kselftest-4.9-rc1-update 2016-10-14 15:17:12 -07:00
scripts kernel-doc: add support for one line inline struct member doc comments 2016-11-16 16:30:27 -07:00
security Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs 2016-10-10 20:16:43 -07:00
sound sound fixes for 4.9-rc1 2016-10-15 09:20:54 -07:00
tools docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
usr usr/Kconfig: make initrd compression algorithm selection not expert 2014-12-13 12:42:52 -08:00
virt KVM/ARM Changes for v4.9 2016-09-29 16:01:51 +02:00
.cocciconfig scripts: add Linux .cocciconfig for coccinelle 2016-07-22 12:13:39 +02:00
.get_maintainer.ignore Add hch to .get_maintainer.ignore 2015-08-21 14:30:10 -07:00
.gitattributes .gitattributes: set git diff driver for C source code files 2016-10-07 18:46:30 -07:00
.gitignore Merge branch 'misc' of git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild 2016-08-02 16:48:52 -04:00
.mailmap Merge branch 'upstream' of git://git.linux-mips.org/pub/scm/ralf/upstream-linus 2016-10-15 09:26:12 -07:00
COPYING
CREDITS CREDITS: update Pavel's information, add GPG key, remove snail mail address 2016-10-07 18:46:30 -07:00
Kbuild scripts/gdb: provide linux constants 2016-05-23 17:04:14 -07:00
Kconfig
MAINTAINERS MAINTAINERS: The Chinese documentation moved 2016-11-13 12:24:59 -07:00
Makefile Linux 4.9-rc1 2016-10-15 12:17:50 -07:00
README README: add a new README file, pointing to the Documentation/ 2016-10-24 08:12:35 -02:00

README 

Linux kernel
============

This file was moved to Documentation/admin-guide/README.rst

Please notice that there are several guides for kernel developers and users.
These guides can be rendered in a number of formats, like HTML and PDF.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.

There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
See Documentation/00-INDEX for a list of what is contained in each file.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.