From: Junio C Hamano <gitster@pobox.com>
To: Stefan Beller <stefanbeller@gmail.com>
Cc: git@vger.kernel.org
Subject: [PATCH v2 3/8] CodingGuidelines: give an example for redirection
Date: Wed, 30 Apr 2014 15:14:07 -0700 [thread overview]
Message-ID: <xmqqsioucvo0.fsf_-_@gitster.dls.corp.google.com> (raw)
In-Reply-To: <1398894312-30763-4-git-send-email-gitster@pobox.com> (Junio C. Hamano's message of "Wed, 30 Apr 2014 14:45:07 -0700")
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
* Instead of using trailing "# correct" comment on each of the
one-liners, group the good ones and the bad ones into two groups
and give (incorrect)/(correct) header like the other patches as
suggested. How does this look?
The only reason I originally did these differently is because
these are two independent examples, and I thought it would make
the difference stand out better to the readers if we showed
good/bad pairs of "cat" and "echo" that way. But as long as we
are not going to add more examples here, I think the result is
not too bad.
Documentation/CodingGuidelines | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 6a8e94b..6bfe96e 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -61,6 +61,14 @@ For shell scripts specifically (not exhaustive):
redirection target in a variable (as shown above), our code does so
because some versions of bash issue a warning without the quotes.
+ (incorrect)
+ cat hello > world < universe
+ echo hello >$world
+
+ (correct)
+ cat hello >world <universe
+ echo hello >"$world"
+
- We prefer $( ... ) for command substitution; unlike ``, it
properly nests. It should have been the way Bourne spelled
it from day one, but unfortunately isn't.
--
2.0.0-rc1-355-gd6d6511
next prev parent reply other threads:[~2014-04-30 22:14 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-04-30 21:45 [PATCH 0/8] Update the CodingGuidelines Junio C Hamano
2014-04-30 21:45 ` [PATCH 1/8] CodingGuidelines: typofix Junio C Hamano
2014-05-01 14:09 ` David Kastrup
2014-05-01 17:51 ` Junio C Hamano
2014-05-01 21:27 ` Jeff King
2014-05-02 18:31 ` Junio C Hamano
2014-05-02 20:33 ` Jeff King
2014-05-02 20:37 ` Felipe Contreras
2014-05-02 20:53 ` David Kastrup
2014-04-30 21:45 ` [PATCH 2/8] CodingGuidelines: give an example for case/esac statement Junio C Hamano
2014-04-30 21:45 ` [PATCH 3/8] CodingGuidelines: give an example for redirection Junio C Hamano
2014-04-30 22:14 ` Junio C Hamano [this message]
2014-04-30 21:45 ` [PATCH 4/8] CodingGuidelines: give an example for control statements Junio C Hamano
2014-04-30 21:54 ` Stefan Beller
2014-04-30 22:03 ` Junio C Hamano
2014-05-01 14:12 ` David Kastrup
2014-05-01 18:00 ` Junio C Hamano
2014-04-30 21:45 ` [PATCH 5/8] CodingGuidelines: give an example for shell function preamble Junio C Hamano
2014-04-30 21:45 ` [PATCH 6/8] CodingGuidelines: call the conditional statement "if ()", not "if()" Junio C Hamano
2014-05-01 14:14 ` David Kastrup
2014-05-01 18:11 ` Junio C Hamano
2014-05-01 18:36 ` David Kastrup
2014-04-30 21:45 ` [PATCH 7/8] CodingGuidelines: on comparison Junio C Hamano
2014-05-01 21:36 ` Jeff King
2014-05-02 18:18 ` Junio C Hamano
2014-05-02 20:31 ` Jeff King
2014-05-02 20:45 ` Junio C Hamano
2014-04-30 21:45 ` [PATCH 8/8] CodingGuidelines: once it is in, it is not worth the code churn Junio C Hamano
2014-05-02 20:51 ` [PATCH 9/8] CodingGuidelines: on splitting a long line Junio C Hamano
2014-05-02 21:00 ` brian m. carlson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqsioucvo0.fsf_-_@gitster.dls.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=stefanbeller@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.