freshlybakedca.ke
Git fork
Merge branch 'jc/doc-opt-tilde-expand'
Describe a case where an option value needs to be spelled as a
separate argument, i.e. "--opt val", not "--opt=val".
* jc/doc-opt-tilde-expand:
doc: option value may be separate for valid reasons
+15
+9
Documentation/gitcli.txt
+9
Documentation/gitcli.txt
···
90
90
for long options. An option that takes optional option-argument must be
91
91
written in the 'stuck' form.
92
92
93
+
* Despite the above suggestion, when Arg is a path relative to the
94
+
home directory of a user, e.g. ~/directory/file or ~u/d/f, you
95
+
may want to use the separate form, e.g. `git foo --file ~/mine`,
96
+
not `git foo --file=~/mine`. The shell will expand `~/` in the
97
+
former to your home directory, but most shells keep the tilde in
98
+
the latter. Some of our commands know how to tilde-expand the
99
+
option value even when given in the stuck form, but not all of
100
+
them do.
101
+
93
102
* When you give a revision parameter to a command, make sure the parameter is
94
103
not ambiguous with a name of a file in the work tree. E.g. do not write
95
104
`git log -1 HEAD` but write `git log -1 HEAD --`; the former will not work
+6
Documentation/gitcredentials.txt
+6
Documentation/gitcredentials.txt
···
242
242
[credential]
243
243
helper = "foo --bar='whitespace arg'"
244
244
245
+
# store helper (discouraged) with custom location for the db file;
246
+
# use `--file ~/.git-secret.txt`, rather than `--file=~/.git-secret.txt`,
247
+
# to allow the shell to expand tilde to the home directory.
248
+
[credential]
249
+
helper = "store --file ~/.git-secret.txt"
250
+
245
251
# you can also use an absolute path, which will not use the git wrapper
246
252
[credential]
247
253
helper = "/path/to/my/helper --with-arguments"