Changes in CodingStyle

08a9a8d4 - doc: re-add CodingStyle and SubmittingPatches

Tue, 18 Oct 2016 11:22:55 +0000

doc: re-add CodingStyle and SubmittingPatchesThose files got moved to Documentation/process, but as they're verywell known files, add pointers to their new locations.PS.: I opted to not merge this patch with the previous onein order to make the diff of the previous one more consistent,as it will show only renames.Signed-off-by: Mauro Carvalho Chehab List of files: /linux-6.15/Documentation/CodingStyle

79c70c30 - docs: Remove space-before-label guidance from CodingStyle

Wed, 21 Sep 2016 21:46:18 +0000

docs: Remove space-before-label guidance from CodingStyleRecent discussion has made it clear that there is no community consensus onthis particular rule. Remove it now, lest it inspire yet another set ofunwanted "cleanup" patches.This partially reverts 865a1caa4b6b (CodingStyle: Clarify and completechapter 7).Cc: Jean Delvare Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

609d99a3 - Documentation/HOWTO: add cross-references to other documents

Mon, 19 Sep 2016 11:07:56 +0000

Documentation/HOWTO: add cross-references to other documentsAdd cross references for the documents mentioned at HOWTO andare 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 onSphinx would require it to be moved to a Documentation/foodirectory.Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

3772ec4a - Documentation/CodingStyle: use the .. note:: markup where needed

Mon, 19 Sep 2016 11:07:47 +0000

Documentation/CodingStyle: use the .. note:: markup where neededThere are two places there where there are notes that shouldbe highlighted. So, use the ReST note markup for such texts.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

5d628b45 - Documentation/CodingStyle: replace underline markups

Mon, 19 Sep 2016 11:07:46 +0000

Documentation/CodingStyle: replace underline markupsSphinx doesn't accept underline markups by purpose.While there are ways to support underline via CSS, this won'tbe 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 List of files: /linux-6.15/Documentation/CodingStyle

b1a3459b - Documentation/CodingStyle: use the proper tag for verbatim font

Mon, 19 Sep 2016 11:07:45 +0000

Documentation/CodingStyle: use the proper tag for verbatim fontOn Sphinx/ReST notation, ``foo`` means that foo will be will bemarked as inline literal, effectively making it to be presentedas 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 anusual typographic convention to use monospaced fonts for functionsand language commands on documents, and we're following suchconvention on the other ReST books.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

d8dbbbc5 - Documentation/CodingStyle: Convert to ReST markup

Mon, 19 Sep 2016 11:07:44 +0000

Documentation/CodingStyle: Convert to ReST markup- Fix all chapter identation;- add c blocks where needed;Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

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

Wed, 13 Jul 2016 00:18:28 +0000

CodingStyle: Remove "Don't use C99-style comments"Because Linus may still be reading source code on greenbar paperinstead of color terminals with code syntax highlighting andappropriate font decorations.Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.comSigned-off-by: Joe Perches List of files: /linux-6.15/Documentation/CodingStyle

865a1caa - CodingStyle: Clarify and complete chapter 7

Mon, 25 Jul 2016 12:29:06 +0000

CodingStyle: Clarify and complete chapter 7Chapter 7 (Centralized exiting of functions) of the coding styledocumentation is unclear at times, and lacks some information (suchas the possibility to indent labels with a single space.) Clarify andcomplete it.Signed-off-by: Jean Delvare Cc: Markus Elfring Cc: Jonathan Corbet Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

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

Wed, 20 Jul 2016 22:43:41 +0000

docs: deprecate kernel-doc-nano-HOWTO.txtNow that the new Sphinx world order is taking over, the information inkernel-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 awarning and fix all the other pointers to it.Reminded-by: Daniel Vetter Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

32fd52d5 - Documentation/CodingStyle: add space before parenthesis in example macro

Mon, 25 Jan 2016 05:54:39 +0000

Documentation/CodingStyle: add space before parenthesis in example macroSigned-off-by: Thomas Gardner Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

9a2885e6 - Documentation: fix typo in CodingStyle

Mon, 28 Dec 2015 10:06:55 +0000

Documentation: fix typo in CodingStyleSimple typo: "it" for "is".Signed-off-by: Manuel Pégourié-Gonnard Cc: Trivial Patch Monkey Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

4b10df7f - Documentation: CodingStyle: remove broken links in the References section

Fri, 03 Jul 2015 01:33:23 +0000

Documentation: CodingStyle: remove broken links in the References sectionRemove 2 broken links for programming reference books in Appendix I. Aftera lookup on an Internet archives web site, it seems that these links havebeen broken for around 3 months. We can then assume that they will not beback up and safely remove them from the documentation.Signed-off-by: Olivier C. Larocque Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

df1027ab - Documentation/CodingStyle: fix example macro parenthesis imbalance

Sun, 19 Apr 2015 03:35:01 +0000

Documentation/CodingStyle: fix example macro parenthesis imbalanceCc: Bartosz Golaszewski Cc: Andrew Morton Fixes: f2027543b9 ('documentation: update CodingStyle on local variables naming in macros')Signed-off-by: Baruch Siach Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

f2027543 - documentation: update CodingStyle on local variables naming in macros

Thu, 16 Apr 2015 19:43:31 +0000

documentation: update CodingStyle on local variables naming in macrosDescribe proper naming convention for local variables in macrosresembling functions.Signed-off-by: Bartosz Golaszewski Cc: Guenter Roeck Cc: Steven Rostedt Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds List of files: /linux-6.15/Documentation/CodingStyle

09677e0f - Documentation/CodingStyle: improve text layout

Mon, 16 Feb 2015 17:26:18 +0000

Documentation/CodingStyle: improve text layoutTry to make coding style documentation look a bit more readable andconsistent with the following: - indent every code example in C to first tab-stop; - surround every code example with empty lines, both top and bottom; - remove empty lines where text looked way too spare; - do not indent examples in elisp and kconfig; - do not do any non-whitespace changes.Signed-off-by: Pavel Kretov Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

696156f0 - Documentation/CodingStyle: fix tab-spaces mixture

Mon, 16 Feb 2015 17:26:17 +0000

Documentation/CodingStyle: fix tab-spaces mixtureCoding style description has a irregular mixture of tabs and spaces in twoplaces which is bad by any means and can possibly hurt somebody's senseof beauty.Signed-off-by: Pavel Kretov Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

039d19a1 - CodingStyle: enable emacs display of trailing whitespace

Mon, 26 Jan 2015 03:26:01 +0000

CodingStyle: enable emacs display of trailing whitespaceSuggest to developers who use emacs that they turn on theinstantaneous trailing-whitespace warning feature.Signed-off-by: Alison Chaiken [jc: untabified to match its surroundings]Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

ea040360 - CodingStyle: add some more error handling guidelines

Tue, 02 Dec 2014 08:59:50 +0000

CodingStyle: add some more error handling guidelinesI added a paragraph on choosing label names, and updated the examplecode to use a better label name. I also cleaned up the example code tomore modern style by moving the allocation out of the initializer andchanging the NULL check.Perhaps the most common type of error handling bug in the kernel is "oneerr bugs". CodingStyle already says that we should "avoid nesting" byusing error labels and one err style error handling tends to havemultiple indent levels, so this was already bad style. But I've added anew paragraph explaining how to avoid one err bugs by using multipleerror labels which is, hopefully, more clear.Signed-off-by: Dan Carpenter Acked-by: Julia Lawall [jc: added GFP_KERNEL to kmalloc() call]Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle

21228a18 - CodingStyle: Add a chapter on conditional compilation

Wed, 29 Oct 2014 18:15:17 +0000

CodingStyle: Add a chapter on conditional compilationDocument several common practices and conventions regarding conditionalcompilation, most notably the preference for ifdefs in headers ratherthan .c files.Signed-off-by: Josh Triplett Acked-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/CodingStyle