linux.git/Documentation/CodingStyle, branch v6.18.21

doc: re-add CodingStyle and SubmittingPatches

2016-10-24T10:12:35+00:00

Those files got moved to Documentation/process, but as they're very
well known files, add pointers to their new locations.

PS.: I opted to not merge this patch with the previous one
in order to make the diff of the previous one more consistent,
as it will show only renames.

Signed-off-by: Mauro Carvalho Chehab

docs-rst: add documents to development-process

2016-10-24T10:12:35+00:00

Add several documents to the development-process ReST book.

As we don't want renames, use symlinks instead, keeping those
documents on their original place.

Acked-by: Greg Kroah-Hartman 
Signed-off-by: Mauro Carvalho Chehab

docs: Remove space-before-label guidance from CodingStyle

2016-09-21T21:53:31+00:00

Recent discussion has made it clear that there is no community consensus on
this particular rule.  Remove it now, lest it inspire yet another set of
unwanted "cleanup" patches.

This partially reverts 865a1caa4b6b (CodingStyle: Clarify and complete
chapter 7).

Cc: Jean Delvare 
Signed-off-by: Jonathan Corbet

Documentation/HOWTO: add cross-references to other documents

2016-09-21T00:41:04+00:00

Add cross references for the documents mentioned at HOWTO and
are under the Documentation/ directory, using the ReST notation.

It should be noticed that HOWTO also mentions the /README file.
We opted to not touch it, for now, as making it build on
Sphinx would require it to be moved to a Documentation/foo
directory.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Greg Kroah-Hartman 
Signed-off-by: Jonathan Corbet

Documentation/CodingStyle: use the .. note:: markup where needed

2016-09-21T00:37:01+00:00

There are two places there where there are notes that should
be highlighted. So, use the ReST note markup for such texts.

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

Documentation/CodingStyle: replace underline markups

2016-09-21T00:36:57+00:00

Sphinx doesn't accept underline markups by purpose.
While there are ways to support underline via CSS, this won't
be portable with non-html outputs.

As we want CodingStyle to do emphasis, replace _foo_ by **foo**,
using bold emphasis.

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

Documentation/CodingStyle: use the proper tag for verbatim font

2016-09-21T00:36:53+00:00

On Sphinx/ReST notation, ``foo`` means that foo will be will be
marked as inline literal, effectively making it to be presented
as a monospaced font.

As we want this document to be parsed by Sphinx, instead of using
"foo", use ``foo`` for the names that are literal, because it is an
usual typographic convention to use monospaced fonts for functions
and language commands on documents, and we're following such
convention on the other ReST books.

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

Documentation/CodingStyle: Convert to ReST markup

2016-09-21T00:35:36+00:00

- Fix all chapter identation;
- add c blocks where needed;

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

CodingStyle: Remove "Don't use C99-style comments"

2016-08-14T19:56:31+00:00

Because Linus may still be reading source code on greenbar paper
instead of color terminals with code syntax highlighting and
appropriate font decorations.

Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.com

Signed-off-by: Joe Perches

CodingStyle: Clarify and complete chapter 7

2016-08-14T18:28:06+00:00

Chapter 7 (Centralized exiting of functions) of the coding style
documentation is unclear at times, and lacks some information (such
as the possibility to indent labels with a single space.) Clarify and
complete it.

Signed-off-by: Jean Delvare 
Cc: Markus Elfring 
Cc: Jonathan Corbet 
Signed-off-by: Jonathan Corbet