{"thread":{"id":"47278","subject":"[PATCH] gitcli: tweak \"man gitcli\" for clarity","startedAt":"2017-11-21T20:54:50Z","lastAt":"2017-11-21T21:26:47Z","messageCount":3,"participants":["Robert P. J. Day","Eric Sunshine"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"333128","messageId":"alpine.LFD.2.21.1711211551230.24935@localhost.localdomain","threadId":"47278","inReplyTo":null,"subject":"[PATCH] gitcli: tweak \"man gitcli\" for clarity","fromName":"Robert P. J. Day","fromEmail":"rpjday@crashcourse.ca","sentAt":"2017-11-21T20:53:22Z","receivedAt":"2017-11-21T20:54:50Z","isPatch":true,"sender":{"key":"rpjday@crashcourse.ca","avatar":"https://avatars.githubusercontent.com/u/226084077?v=4"},"body":"No major changes, just some rewording and showing some variations of\ngeneral Git commands.\n\nSigned-off-by: Robert P. J. Day <rpjday@crashcourse.ca>\n\n---\n\ndiff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt\nindex 9f13266a6..a4efcb7ce 100644\n--- a/Documentation/gitcli.txt\n+++ b/Documentation/gitcli.txt\n@@ -13,7 +13,7 @@ gitcli\n DESCRIPTION\n -----------\n\n-This manual describes the convention used throughout Git CLI.\n+This manual describes the common conventions used throughout Git CLI.\n\n Many commands take revisions (most often \"commits\", but sometimes\n \"tree-ish\", depending on the context and command) and paths as their\n@@ -32,32 +32,35 @@ arguments.  Here are the rules:\n    between the HEAD commit and the work tree as a whole\".  You can say\n    `git diff HEAD --` to ask for the latter.\n\n- * Without disambiguating `--`, Git makes a reasonable guess, but errors\n-   out and asking you to disambiguate when ambiguous.  E.g. if you have a\n+ * Without a disambiguating `--`, Git makes a reasonable guess, but can\n+   error out, asking you to disambiguate when ambiguous.  E.g. if you have a\n    file called HEAD in your work tree, `git diff HEAD` is ambiguous, and\n    you have to say either `git diff HEAD --` or `git diff -- HEAD` to\n    disambiguate.\n +\n When writing a script that is expected to handle random user-input, it is\n a good practice to make it explicit which arguments are which by placing\n-disambiguating `--` at appropriate places.\n+a disambiguating `--` at appropriate places.\n\n  * Many commands allow wildcards in paths, but you need to protect\n-   them from getting globbed by the shell.  These two mean different\n-   things:\n+   them from getting globbed by the shell.  The following commands have\n+   two different meanings:\n +\n --------------------------------\n $ git checkout -- *.c\n+\n $ git checkout -- \\*.c\n+$ git checkout -- \"*.c\"\n+$ git checkout -- '*.c'\n --------------------------------\n +\n-The former lets your shell expand the fileglob, and you are asking\n-the dot-C files in your working tree to be overwritten with the version\n-in the index.  The latter passes the `*.c` to Git, and you are asking\n-the paths in the index that match the pattern to be checked out to your\n-working tree.  After running `git add hello.c; rm hello.c`, you will _not_\n-see `hello.c` in your working tree with the former, but with the latter\n-you will.\n+The first command lets your shell expand the fileglob, and you are asking\n+the dot-C files in your working tree to be overwritten with the version in\n+the index.  The latter three variations pass the `*.c` to Git, and you are\n+asking the paths in the index that match the pattern to be checked out to\n+your working tree.  After running `git add hello.c; rm hello.c`, you will\n+_not_ see `hello.c` in your working tree with the first command, but with\n+the latter three variations, you will.\n\n  * Just as the filesystem '.' (period) refers to the current directory,\n    using a '.' as a repository name in Git (a dot-repository) is a relative\n\n-- \n\n========================================================================\nRobert P. J. Day                                 Ottawa, Ontario, CANADA\n                        http://crashcourse.ca\n\nTwitter:                                       http://twitter.com/rpjday\nLinkedIn:                               http://ca.linkedin.com/in/rpjday\n========================================================================\n"},{"id":"333165","messageId":"CAPig+cS2i1WOYg1d3fup0PPq_HzJE_XXXtkEMqxq=1Fc9E1sMQ@mail.gmail.com","threadId":"47278","inReplyTo":"alpine.LFD.2.21.1711211551230.24935@localhost.localdomain","subject":"Re: [PATCH] gitcli: tweak \"man gitcli\" for clarity","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2017-11-21T21:24:25Z","receivedAt":"2017-11-21T21:24:30Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, Nov 21, 2017 at 3:53 PM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:\n> No major changes, just some rewording and showing some variations of\n> general Git commands.\n>\n> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>\n> ---\n> diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt\n> @@ -13,7 +13,7 @@ gitcli\n>  DESCRIPTION\n>  -----------\n>\n> -This manual describes the convention used throughout Git CLI.\n> +This manual describes the common conventions used throughout Git CLI.\n\nThe Department of Redundancy department...\n"},{"id":"333166","messageId":"alpine.LFD.2.21.1711211624560.26021@localhost.localdomain","threadId":"47278","inReplyTo":"CAPig+cS2i1WOYg1d3fup0PPq_HzJE_XXXtkEMqxq=1Fc9E1sMQ@mail.gmail.com","subject":"Re: [PATCH] gitcli: tweak \"man gitcli\" for clarity","fromName":"Robert P. J. Day","fromEmail":"rpjday@crashcourse.ca","sentAt":"2017-11-21T21:25:20Z","receivedAt":"2017-11-21T21:26:47Z","isPatch":true,"sender":{"key":"rpjday@crashcourse.ca","avatar":"https://avatars.githubusercontent.com/u/226084077?v=4"},"body":"On Tue, 21 Nov 2017, Eric Sunshine wrote:\n\n> On Tue, Nov 21, 2017 at 3:53 PM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:\n> > No major changes, just some rewording and showing some variations of\n> > general Git commands.\n> >\n> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>\n> > ---\n> > diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt\n> > @@ -13,7 +13,7 @@ gitcli\n> >  DESCRIPTION\n> >  -----------\n> >\n> > -This manual describes the convention used throughout Git CLI.\n> > +This manual describes the common conventions used throughout Git CLI.\n>\n> The Department of Redundancy department...\n\n  oh, fine, reduced redundancy coming shortly ...\n\nrday\n\n-- \n\n========================================================================\nRobert P. J. Day                                 Ottawa, Ontario, CANADA\n                        http://crashcourse.ca\n\nTwitter:                                       http://twitter.com/rpjday\nLinkedIn:                               http://ca.linkedin.com/in/rpjday\n========================================================================\n"}]}