git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] Document bash style we prefer for if and functions

From
Heiko Voigt <hvoigt@hvoigt.net>
Date
Aug 14, 2012, 20:39 UTC
Message-ID
<20120814203931.GB33843@book.hvoigt.net>

During discussion of other patches these preferences have been revealed. Lets add them to the guidelines.

Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>
---
 Documentation/CodingGuidelines | 6 ++++++
 1 file changed, 6 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 4557711..0a07990 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -76,11 +76,16 @@ For shell scripts specifically (not exhaustive):
 
  - We do not use Process Substitution <(list) or >(list).
 
+ - We prefer "then" on the next line for if statements.
+
  - We prefer "test" over "[ ... ]".
 
  - We do not write the noiseword "function" in front of shell
    functions.
 
+ - We prefer a space between the function name and the parentheses.
+   E.g.: my_function ()
+
  - As to use of grep, stick to a subset of BRE (namely, no \{m,n\},
    [::], [==], nor [..]) for portability.
 
@@ -97,6 +102,7 @@ For shell scripts specifically (not exhaustive):
    interface translatable. See "Marking strings for translation" in
    po/README.
 
+
 For C programs:
 
  - We use tabs to indent, and interpret tabs as taking up to
-- 
1.7.12.rc2.11.g5d52328
Next: Junio C Hamano
Message 1 of 4 in “Document bash style we prefer for if and functions”
  1. Document bash style we prefer for if and functionsHeiko Voigt, Aug 14, 2012
  2. Junio C HamanoAug 14, 2012
  3. add some bash style we preferHeiko Voigt, Aug 15, 2012
  4. Junio C HamanoAug 15, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.