diff options
| author | Junio C Hamano <gitster@pobox.com> | 2012-05-02 13:51:45 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-05-02 13:51:45 -0700 |
| commit | d274fc093cbdcddbf9aff5f79de4e9445f3363d7 (patch) | |
| tree | 0abf168a8760bee8686a8836b4b29a366eab0118 /Documentation/gitcli.txt | |
| parent | 1be65eda6a7018445ebdd9cfec4b1caab4db34ba (diff) | |
| parent | 6cf378f0cbe7c7f944637892caeb9058c90a185a (diff) | |
| download | git-d274fc093cbdcddbf9aff5f79de4e9445f3363d7.tar.xz | |
Merge branch 'jk/doc-asciidoc-inline-literal'
Our documentation was written for an ancient version of AsciiDoc,
making the source not very readable.
By Jeff King
* jk/doc-asciidoc-inline-literal:
docs: stop using asciidoc no-inline-literal
Diffstat (limited to 'Documentation/gitcli.txt')
| -rw-r--r-- | Documentation/gitcli.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index f734f97b8e..ea17f7a53b 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -25,22 +25,22 @@ arguments. Here are the rules: are paths. * When an argument can be misunderstood as either a revision or a path, - they can be disambiguated by placing `\--` between them. - E.g. `git diff \-- HEAD` is, "I have a file called HEAD in my work + they can be disambiguated by placing `--` between them. + E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work tree. Please show changes between the version I staged in the index and what I have in the work tree for that file". not "show difference between the HEAD commit and the work tree as a whole". You can say - `git diff HEAD \--` to ask for the latter. + `git diff HEAD --` to ask for the latter. - * Without disambiguating `\--`, git makes a reasonable guess, but errors + * Without disambiguating `--`, git makes a reasonable guess, but errors out and asking you to disambiguate when ambiguous. E.g. if you have a file called HEAD in your work tree, `git diff HEAD` is ambiguous, and - you have to say either `git diff HEAD \--` or `git diff \-- HEAD` to + you have to say either `git diff HEAD --` or `git diff -- HEAD` to disambiguate. When writing a script that is expected to handle random user-input, it is a good practice to make it explicit which arguments are which by placing -disambiguating `\--` at appropriate places. +disambiguating `--` at appropriate places. Here are the rules regarding the "flags" that you should follow when you are scripting git: |
