From: Junio C Hamano Date: Tue, 17 Dec 2013 19:36:38 +0000 (-0800) Subject: Merge branch 'jj/doc-markup-gitcli' into maint X-Git-Tag: v1.8.5.2~4 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/c8394bb46667c059f00433224f09bda8de878128?ds=inline;hp=-c Merge branch 'jj/doc-markup-gitcli' into maint * jj/doc-markup-gitcli: Documentation/gitcli.txt: fix double quotes --- c8394bb46667c059f00433224f09bda8de878128 diff --combined Documentation/gitcli.txt index 3146413cce,c8feb72240..41bed2983f --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@@ -59,10 -59,6 +59,10 @@@ working tree. After running `git add h see `hello.c` in your working tree with the former, but with the latter you will. + * Just as the filesystem '.' (period) refers to the current directory, + using a '.' as a repository name in Git (a dot-repository) is a relative + path and means your current repository. + Here are the rules regarding the "flags" that you should follow when you are scripting Git: @@@ -83,12 -79,12 +83,12 @@@ `git log -1 HEAD` but write `git log -1 HEAD --`; the former will not work if you happen to have a file called `HEAD` in the work tree. - * many commands allow a long option "--option" to be abbreviated + * many commands allow a long option `--option` to be abbreviated only to their unique prefix (e.g. if there is no other option - whose name begins with "opt", you may be able to spell "--opt" to - invoke the "--option" flag), but you should fully spell them out + whose name begins with `opt`, you may be able to spell `--opt` to + invoke the `--option` flag), but you should fully spell them out when writing your scripts; later versions of Git may introduce a - new option whose name shares the same prefix, e.g. "--optimize", + new option whose name shares the same prefix, e.g. `--optimize`, to make a short prefix that used to be unique no longer unique. @@@ -110,7 -106,7 +110,7 @@@ couple of magic command line options + --------------------------------------------- $ git describe -h -usage: git describe [options] * +usage: git describe [options] * or: git describe [options] --dirty --contains find the tag that comes after the commit @@@ -149,7 -145,7 +149,7 @@@ prefix of a long option as if it is ful with a caution. For example, `git commit --amen` behaves as if you typed `git commit --amend`, but that is true only until a later version of Git introduces another option that shares the same prefix, - e.g `git commit --amenity" option. + e.g. `git commit --amenity` option. Separating argument from the option