linux-stable.git/Documentation/kernel-doc-nano-HOWTO.txt, branch master

docs: get rid of kernel-doc-nano-HOWTO.txt

2017-12-21T20:41:46+00:00

Everything there is already described at
Documentation/doc-guide/kernel-doc.rst. So, there's no reason why
to keep it anymore.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs: update old references for DocBook from the documentation

2017-05-16T11:44:19+00:00

DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.

Acked-by: SeongJae Park 
Signed-off-by: Mauro Carvalho Chehab

docs-rst: doc-guide: split the kernel-documentation.rst contents

2016-11-19T17:22:04+00:00

Having the kernel-documentation at the topmost level doesn't
allow generating a separate PDF file for it. Also, makes harder
to add extra contents. So, place it on a sub-dir.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs: deprecate kernel-doc-nano-HOWTO.txt

2016-07-20T22:45:37+00:00

Now that the new Sphinx world order is taking over, the information in
kernel-doc-nano-HOWTO.txt is outmoded.  I hate to remove it altogether,
since it's one of those files that people expect to find.  But we can add a
warning and fix all the other pointers to it.

Reminded-by: Daniel Vetter 
Signed-off-by: Jonathan Corbet

Documenation: Update location of docproc.c

2015-07-14T18:36:39+00:00

docproc.c was moved in 2011 from scripts/basic to scripts
-> updated the references accordingly

Signed-off-by: Peter Huewe 
Signed-off-by: Jonathan Corbet

kernel-doc: Update references to SGML to refs to XML instead.

2013-05-28T10:02:11+00:00

Since the "sgmldocs" target is simply a pointer to the newer "xmldocs"
target, update the documentation to reflect this.

Signed-off-by: Robert P. J. Day 
Signed-off-by: Jiri Kosina

Kernel-doc: Convention: Use a "Return" section to describe return values

2012-11-27T20:08:57+00:00

Non-void functions should describe their return values in their kernel-doc
comments. Currently, some don't, others do in various forms. For example:
   * Return the result.
   * Return: The result.
   * Returns the result.
   * Returns: the result.
   * Return Value: The result.
   * @return: the result.
   * This function returns the result.
   * It will return the result.

Defining a convention would improve consistency of kernel-doc comments. It
would also help scripts/kernel-doc identify the text describing the return
value of a function. Thus allowing additional checks on the comments, and
suitable highlighting in the generated docs (man pages, html, etc).

So, as a convention, use a section named "Return" to describe the return
value of a function.

Signed-off-by: Yacine Belkadi 
Signed-off-by: Rob Landley 
Signed-off-by: Jiri Kosina

docbook: warn on unused doc entries

2010-09-11T23:49:21+00:00

When you don't use !E or !I but only !F, then it's very easy to miss
including some functions, structs etc.  in documentation.  To help
finding which ones were missed, allow printing out the unused ones as
warnings.

For example, using this on mac80211 yields a lot of warnings like this:

  Warning: didn't use docs for DOC: mac80211 workqueue
  Warning: didn't use docs for ieee80211_max_queues
  Warning: didn't use docs for ieee80211_bss_change
  Warning: didn't use docs for ieee80211_bss_conf

when generating the documentation for it.

Signed-off-by: Johannes Berg 
Signed-off-by: Randy Dunlap 
Signed-off-by: Linus Torvalds

documentation: update kernel-doc-nano-HOWTO information

2010-01-11T17:34:07+00:00

Remove comments about function short descriptions not allowed to be on
multiple lines (that was fixed/changed recently).

Add comments that function "section header:" names need to be unique per
function/struct/union/typedef/enum.

Signed-off-by: Randy Dunlap 
Signed-off-by: Andrew Morton 
Signed-off-by: Linus Torvalds

kernel-doc: allow multi-line declaration purpose descriptions

2009-09-18T16:48:52+00:00

Allow the short description after symbol name and dash in a kernel-doc
comment to span multiple lines, e.g. like this:

	/**
	 * unmap_mapping_range - unmap the portion of all mmaps in the
	 *	specified address_space corresponding to the specified
	 *	page range in the underlying file.
	 * @mapping: the address space containing mmaps to be unmapped.
	 * ...
	 */

The short description ends with a parameter description, an empty line
or the end of the comment block.

Signed-off-by: Johannes Weiner 
Signed-off-by: Randy Dunlap 
Signed-off-by: Linus Torvalds