{"thread":{"id":"32052","subject":"git-reset man page","startedAt":"2012-11-10T09:55:13Z","lastAt":"2012-11-18T17:48:59Z","messageCount":6,"participants":["Angelo Borsotti","Krzysztof Mazur","Junio C Hamano","Drew Northup"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"202743","messageId":"CAB9Jk9AdTBJotrB0fndZawMWH6hS4PW_5bHwecwY5Vz7=TnYAA@mail.gmail.com","threadId":"32052","inReplyTo":null,"subject":"git-reset man page","fromName":"Angelo Borsotti","fromEmail":"angelo.borsotti@gmail.com","sentAt":"2012-11-10T09:55:13Z","receivedAt":"2012-11-10T09:55:13Z","isPatch":false,"sender":{"key":"angelo.borsotti@gmail.com","avatar":null},"body":"Hi\n\nthe man page of git-reset, synopsys, does not allow for an\nargumentless call, and the description does not tell either what is\nthe meaning of it.\nSuggested changes:\n\nfirst line of synopsis:\n\n      gitt reset [-q] [<commit>] [ [--] <pathspec> ...]\n\nDescription: append to the end of the first paragraph:\n\n     \"If no <pathspecs> are specified, all the index entries are reset.\"\n\nI would suggest to change <paths> with <pathspec> in all the man page\nbecause paths in the glossary are called pathspecs.\n\n-Angelo Borsotti\n"},{"id":"202759","messageId":"20121110155718.GA29321@shrek.podlesie.net","threadId":"32052","inReplyTo":"CAB9Jk9AdTBJotrB0fndZawMWH6hS4PW_5bHwecwY5Vz7=TnYAA@mail.gmail.com","subject":"Re: git-reset man page","fromName":"Krzysztof Mazur","fromEmail":"krzysiek@podlesie.net","sentAt":"2012-11-10T15:57:18Z","receivedAt":"2012-11-10T15:57:18Z","isPatch":false,"sender":{"key":"krzysiek@podlesie.net","avatar":null},"body":"On Sat, Nov 10, 2012 at 10:55:13AM +0100, Angelo Borsotti wrote:\n> Hi\n> \n> the man page of git-reset, synopsys, does not allow for an\n> argumentless call, and the description does not tell either what is\n> the meaning of it.\n\nThis issue was already reported by Bojan Petrović:\nhttp://thread.gmane.org/gmane.comp.version-control.git/208505\n\nand fixed in commit d505865be5c7d72abb74318940e8c4c52aa0db5f\n(doc: git-reset: make \"<mode>\" optional) in master branch.\n\n\"git reset\" is equivalent to \"git reset --mixed\".\n\n> Suggested changes:\n> \n> first line of synopsis:\n> \n>       gitt reset [-q] [<commit>] [ [--] <pathspec> ...]\n> \n> Description: append to the end of the first paragraph:\n> \n>      \"If no <pathspecs> are specified, all the index entries are reset.\"\n> \n> I would suggest to change <paths> with <pathspec> in all the man page\n> because paths in the glossary are called pathspecs.\n> \n\nThe <paths> issue seems to be bigger - \"<path>\", \"<paths>\" and \"<pathspec>\"\nare mixed in whole manual:\n\n$ cat Documentation/*.txt | grep -o '<path[^>]*>' | sort | uniq -c |\nsort -n -r\n    125 <path>\n     17 <paths>\n     10 <pathspec>\n      2 <pathtemplate>\n      2 <path-pattern>\n      1 <path_to>\n      1 <path_from>\n\nIn commands it's even worse:\n$ cat builtin/*.c | grep -o '<path[^>]*>' | sort | uniq -c | sort -n -r\n     14 <path>\n     15 <paths>\n\nNote: <path> is not always used for pathspec.\n\nIn git-checkout manual in synopsis \"<paths>\" is used, but in description\n\"<pathspec>\".\n\n\nMaybe we should just add that <paths> is an shortcut for <pathspec>\nand fix places where paths and pathspec are mixed or <path> is used as\n<pathspec>.\n\n\nThanks,\n\nKrzysiek\n"},{"id":"202781","messageId":"7v8va9p6pn.fsf@alter.siamese.dyndns.org","threadId":"32052","inReplyTo":"20121110155718.GA29321@shrek.podlesie.net","subject":"Re: git-reset man page","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-11-10T20:02:12Z","receivedAt":"2012-11-10T20:02:12Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Krzysztof Mazur <krzysiek@podlesie.net> writes:\n\n> Maybe we should just add that <paths> is an shortcut for <pathspec>\n> and fix places where paths and pathspec are mixed or <path> is used as\n> <pathspec>.\n\nWe should unify uses of <paths> and <path> (the former should be\n<path>... or something).\n\nSome places you need to give exact path (iow, these places you\ncannot use pathspec), while most other places pathspec\n(i.e. matching pattern) is accepted.\n\nThe manual correctly updated will most likely to use both <path> and\n<pathspec> appropriately.\n"},{"id":"202782","messageId":"20121110204633.GA29363@shrek.podlesie.net","threadId":"32052","inReplyTo":"7v8va9p6pn.fsf@alter.siamese.dyndns.org","subject":"Re: git-reset man page","fromName":"Krzysztof Mazur","fromEmail":"krzysiek@podlesie.net","sentAt":"2012-11-10T20:46:33Z","receivedAt":"2012-11-10T20:46:33Z","isPatch":false,"sender":{"key":"krzysiek@podlesie.net","avatar":null},"body":"On Sat, Nov 10, 2012 at 12:02:12PM -0800, Junio C Hamano wrote:\n> Krzysztof Mazur <krzysiek@podlesie.net> writes:\n> \n> > Maybe we should just add that <paths> is an shortcut for <pathspec>\n> > and fix places where paths and pathspec are mixed or <path> is used as\n> > <pathspec>.\n> \n> We should unify uses of <paths> and <path> (the former should be\n> <path>... or something).\n\nCurrently in most cases \"<paths>...\" is used ;)\n\n> \n> Some places you need to give exact path (iow, these places you\n> cannot use pathspec), while most other places pathspec\n> (i.e. matching pattern) is accepted.\n\nI know, thats why I added a note that \"<path> is not always used for pathspec\".\n\n> \n> The manual correctly updated will most likely to use both <path> and\n> <pathspec> appropriately.\n\nSo we should always use \"<path>\" for exact path, and \"<pathspec>\" for\npathspecs patterns as defined in gitglossary. I think it's better\nto avoid \"<paths>\" and always use \"<path>...\" or \"<pathspec>...\".\n\nKrzysiek\n"},{"id":"203492","messageId":"CAM9Z-nkon5ZtPuqxL0HZPr1es9DSpLA+70++hYpTR4D7WTxbUA@mail.gmail.com","threadId":"32052","inReplyTo":"20121110204633.GA29363@shrek.podlesie.net","subject":"Re: git-reset man page","fromName":"Drew Northup","fromEmail":"n1xim.email@gmail.com","sentAt":"2012-11-18T16:55:09Z","receivedAt":"2012-11-18T16:55:09Z","isPatch":false,"sender":{"key":"n1xim.email@gmail.com","avatar":null},"body":"On Sat, Nov 10, 2012 at 3:46 PM, Krzysztof Mazur <krzysiek@podlesie.net> wrote:\n> On Sat, Nov 10, 2012 at 12:02:12PM -0800, Junio C Hamano wrote:\n>> Krzysztof Mazur <krzysiek@podlesie.net> writes:\n>>\n>> > Maybe we should just add that <paths> is an shortcut for <pathspec>\n>> > and fix places where paths and pathspec are mixed or <path> is used as\n>> > <pathspec>.\n>>\n>> We should unify uses of <paths> and <path> (the former should be\n>> <path>... or something).\n>\n> Currently in most cases \"<paths>...\" is used ;)\n\n> So we should always use \"<path>\" for exact path, and \"<pathspec>\" for\n> pathspecs patterns as defined in gitglossary. I think it's better\n> to avoid \"<paths>\" and always use \"<path>...\" or \"<pathspec>...\"\n\nI suspect that the only reason why the differentiation between\n\"<path>\" and \"<paths>\" happened is because there may be some places\nwhere it was seen that a _list of paths_ was acceptable (which isn't a\npathspec, as it isn't a search expression) and other places where\n_only_ a single path was acceptable. Should that fail to be the case\nthen there would be a good argument for changing the affected\ninstances of \"<paths>\" to \"<path>\" in the documentation. (I know of no\nother good way to pluralize \"<path>\" myself.)\n\n-- \n-Drew Northup\n--------------------------------------------------------------\n\"As opposed to vegetable or mineral error?\"\n-John Pescatore, SANS NewsBites Vol. 12 Num. 59\n"},{"id":"203496","messageId":"20121118174859.GA29052@shrek.podlesie.net","threadId":"32052","inReplyTo":"CAM9Z-nkon5ZtPuqxL0HZPr1es9DSpLA+70++hYpTR4D7WTxbUA@mail.gmail.com","subject":"Re: git-reset man page","fromName":"Krzysztof Mazur","fromEmail":"krzysiek@podlesie.net","sentAt":"2012-11-18T17:48:59Z","receivedAt":"2012-11-18T17:48:59Z","isPatch":false,"sender":{"key":"krzysiek@podlesie.net","avatar":null},"body":"On Sun, Nov 18, 2012 at 11:55:09AM -0500, Drew Northup wrote:\n> \n> > So we should always use \"<path>\" for exact path, and \"<pathspec>\" for\n> > pathspecs patterns as defined in gitglossary. I think it's better\n> > to avoid \"<paths>\" and always use \"<path>...\" or \"<pathspec>...\"\n> \n> I suspect that the only reason why the differentiation between\n> \"<path>\" and \"<paths>\" happened is because there may be some places\n> where it was seen that a _list of paths_ was acceptable (which isn't a\n> pathspec, as it isn't a search expression) and other places where\n\n<paths> is usually used for a list of <pathspec>, not just a list of <path>.\n\n> _only_ a single path was acceptable. Should that fail to be the case\n> then there would be a good argument for changing the affected\n> instances of \"<paths>\" to \"<path>\" in the documentation. (I know of no\n> other good way to pluralize \"<path>\" myself.)\n> \n\nI think it's best to just add \"...\":\n\n<path> for single exact path,\n<path>... for a list of exact paths,\n<pathspec> for single pathspec,\n<pathspec>... for a list of pathspecs.\n\nKrzysiek\n"}]}