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

[PATCH v2] add some bash style we prefer

From
Heiko Voigt <hvoigt@hvoigt.net>
Date
Aug 15, 2012, 17:06 UTC
Message-ID
<20120815170601.GB43523@book.hvoigt.net>
In-Reply-To
<7vipcl89kg.fsf@alter.siamese.dyndns.org>

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

Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>
---
Here an updated version of the patch.
On Tue, Aug 14, 2012 at 02:09:35PM -0700, Junio C Hamano wrote:
Show 10 quoted lines
> Heiko Voigt <hvoigt@hvoigt.net> writes:
> > @@ -97,6 +102,7 @@ For shell scripts specifically (not exhaustive):
> >     interface translatable. See "Marking strings for translation" in
> >     po/README.
> >  
> > +
> >  For C programs:
> 
> Probably not needed, as there is no such double space between C
> and Documentation sections.
Sorry about that whitespace noise.
Cheers Heiko
 Documentation/CodingGuidelines | 8 ++++++++
 1 file changed, 8 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 4557711..e70d110 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -76,11 +76,19 @@ For shell scripts specifically (not exhaustive):
 
  - We do not use Process Substitution <(list) or >(list).
 
+ - We prefer writing all control structures without semicolon on the
+   same line. E.g. "then" should be on the next line for if statements.
+   The same applies to while, for, ...
+
  - 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. The
+   opening "{" should also be on the same line.
+   E.g.: my_function () {
+
  - As to use of grep, stick to a subset of BRE (namely, no \{m,n\},
    [::], [==], nor [..]) for portability.
 
-- 
1.7.12.rc2.11.g5d52328
Previous: Junio C HamanoNext: Junio C Hamano
Message 3 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.