Skip to content

Commit bb77ea6

Browse files
committed
rn-53: improve quoting shell comments
1 parent af49f2d commit bb77ea6

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎rev_news/drafts/edition-53.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -62,34 +62,34 @@ This edition covers what happened during the month of June 2019.
6262

6363
The comments above the function explains it like this:
6464

65-
```sh
66-
# Similar to test_commit, but efficiently create <nr> commits, each with a
67-
# unique number $n (from 1 to <nr> by default) in the commit message.
68-
#
69-
# Usage: test_commit_bulk [options] <nr>
70-
# -C <dir>:
71-
# Run all git commands in directory <dir>
72-
# --ref=<n>:
73-
# ref on which to create commits (default: HEAD)
74-
# --start=<n>:
75-
# number commit messages from <n> (default: 1)
76-
# --message=<msg>:
77-
# use <msg> as the commit mesasge (default: "commit $n")
78-
# --filename=<fn>:
79-
# modify <fn> in each commit (default: $n.t)
80-
# --contents=<string>:
81-
# place <string> in each file (default: "content $n")
82-
# --id=<string>:
83-
# shorthand to use <string> and $n in message, filename, and contents
84-
#
85-
# The message, filename, and contents strings are evaluated by the shell inside
86-
# double-quotes, with $n set to the current commit number. So you can do:
87-
#
88-
# test_commit_bulk --filename=file --contents='modification $n'
89-
#
90-
# to have every commit touch the same file, but with unique content. Spaces are
91-
# OK, but you must escape any metacharacters (like backslashes or
92-
# double-quotes) you do not want expanded.
65+
```
66+
# Similar to test_commit, but efficiently create <nr> commits, each with a
67+
# unique number $n (from 1 to <nr> by default) in the commit message.
68+
#
69+
# Usage: test_commit_bulk [options] <nr>
70+
# -C <dir>:
71+
# Run all git commands in directory <dir>
72+
# --ref=<n>:
73+
# ref on which to create commits (default: HEAD)
74+
# --start=<n>:
75+
# number commit messages from <n> (default: 1)
76+
# --message=<msg>:
77+
# use <msg> as the commit mesasge (default: "commit $n")
78+
# --filename=<fn>:
79+
# modify <fn> in each commit (default: $n.t)
80+
# --contents=<string>:
81+
# place <string> in each file (default: "content $n")
82+
# --id=<string>:
83+
# shorthand to use <string> and $n in message, filename, and contents
84+
#
85+
# The message, filename, and contents strings are evaluated by the shell inside
86+
# double-quotes, with $n set to the current commit number. So you can do:
87+
#
88+
# test_commit_bulk --filename=file --contents='modification $n'
89+
#
90+
# to have every commit touch the same file, but with unique content. Spaces are
91+
# OK, but you must escape any metacharacters (like backslashes or
92+
# double-quotes) you do not want expanded.
9393
```
9494

9595
Johannes Schindelin replied to Peff that he likes the direction

0 commit comments

Comments
(0)