{"thread":{"id":"38004","subject":"Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis","startedAt":"2014-11-18T23:16:55Z","lastAt":"2014-11-19T21:40:14Z","messageCount":3,"participants":["Slavomir Vlcek","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"252143","messageId":"546BD367.40301@inventati.org","threadId":"38004","inReplyTo":null,"subject":"Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis","fromName":"Slavomir Vlcek","fromEmail":"svlc@inventati.org","sentAt":"2014-11-18T23:16:55Z","receivedAt":"2014-11-18T23:16:55Z","isPatch":true,"sender":{"key":"svlc@inventati.org","avatar":"https://avatars.githubusercontent.com/u/1921302?v=4"},"body":"Add synopsis with the '--comment-lines' option.\n\nSigned-off-by: Slavomir Vlcek <svlc@inventati.org>\n---\n\nHi,\nthere were no mention of '--comment-lines' in the synopsis.\n\n('--comment-lines' and '--strip-comments' options\nare mutually exclusive).\n\nI solved this by adding an extra (second) synopsis line\nso it looks just like the 'usage_msg' in 'builtin/stripspace.c'.\n\nBut perhaps it would be wiser to have something like\n\"git stripspace [[-s | --strip-comments] | [-c | --comment-lines]] < input\"\ninstead (and perhaps ordered alphabetically).\nThis approach can be seen e.g. in the git-add man page.\n\nFor the 'master'.\n\n\nAlso, have a few questions about stripspace generally:\na) Should 'git stripspace --comment-lines' really leave the trailing\nwhitespace alone (example: ' hello  '->'# hello  ')?\nb) In the documentation there is:\n\"-s, --strip-comments\n           Skip and remove all lines starting with comment character (default #).\"\n\npart. This \"default\" word somehow suggests some new command option that would\nallow to change the comment character. Would you accept a patch implementing\nthis or such functionality is not desired.\n\nThank you.\n\n\n Documentation/git-stripspace.txt | 1 +\n 1 file changed, 1 insertion(+)\n\ndiff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt\nindex c87bfcb..6c6e989 100644\n--- a/Documentation/git-stripspace.txt\n+++ b/Documentation/git-stripspace.txt\n@@ -10,6 +10,7 @@ SYNOPSIS\n --------\n [verse]\n 'git stripspace' [-s | --strip-comments] < input\n+'git stripspace' [-c | --comment-lines] < input\n \n DESCRIPTION\n -----------\n-- \n2.0.1\n"},{"id":"252146","messageId":"546BD65F.3070808@inventati.org","threadId":"38004","inReplyTo":"546BD367.40301@inventati.org","subject":"Re: Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis","fromName":"Slavomir Vlcek","fromEmail":"svlc@inventati.org","sentAt":"2014-11-18T23:29:35Z","receivedAt":"2014-11-18T23:29:35Z","isPatch":true,"sender":{"key":"svlc@inventati.org","avatar":"https://avatars.githubusercontent.com/u/1921302?v=4"},"body":"\nOn 11/19/2014 12:16 AM, Slavomir Vlcek wrote:\n> b) In the documentation there is:\n> \"-s, --strip-comments\n>            Skip and remove all lines starting with comment character (default #).\"\n> \n> part. This \"default\" word somehow suggests some new command option that would\n> allow to change the comment character. Would you accept a patch implementing\n> this or such functionality is not desired.\n\nI take it back, just found that there is a global \"comment_line_char\" variable\nthat controls this stuff. Apologizing.\n"},{"id":"252211","messageId":"xmqqk32qrhs1.fsf@gitster.dls.corp.google.com","threadId":"38004","inReplyTo":"546BD367.40301@inventati.org","subject":"Re: Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-11-19T21:40:14Z","receivedAt":"2014-11-19T21:40:14Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Slavomir Vlcek <svlc@inventati.org> writes:\n\n> I solved this by adding an extra (second) synopsis line\n> so it looks just like the 'usage_msg' in 'builtin/stripspace.c'.\n>\n> But perhaps it would be wiser to have something like\n> \"git stripspace [[-s | --strip-comments] | [-c | --comment-lines]] < input\"\n> instead (and perhaps ordered alphabetically).\n\nThat might be more \"manly\" but much less friendly to humans compared\nto what your patch gives us.\n\nThese two modes are really about two different operations (the\nlatter is not \"strip\" at all, but is about adding spaces, to which\n\"comments\" are often equated to), and two-line synopsis shows more\nprominently that they are distinct, which I think is the right thing\nto do.\n\n> diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt\n> index c87bfcb..6c6e989 100644\n> --- a/Documentation/git-stripspace.txt\n> +++ b/Documentation/git-stripspace.txt\n> @@ -10,6 +10,7 @@ SYNOPSIS\n>  --------\n>  [verse]\n>  'git stripspace' [-s | --strip-comments] < input\n> +'git stripspace' [-c | --comment-lines] < input\n>  \n>  DESCRIPTION\n>  -----------\n"}]}