{"thread":{"id":"22658","subject":"[PATCH] Documentation: Fix indentation problem in git-commit(1)","startedAt":"2010-02-15T00:45:17Z","lastAt":"2010-02-20T05:28:38Z","messageCount":5,"participants":["Jacob Helwig","Thomas Rast","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"134584","messageId":"1266194717-25438-1-git-send-email-jacob.helwig@gmail.com","threadId":"22658","inReplyTo":null,"subject":"[PATCH] Documentation: Fix indentation problem in git-commit(1)","fromName":"Jacob Helwig","fromEmail":"jacob.helwig@gmail.com","sentAt":"2010-02-15T00:45:17Z","receivedAt":"2010-02-15T00:45:17Z","isPatch":true,"sender":{"key":"jacob.helwig@gmail.com","avatar":"https://avatars.githubusercontent.com/u/14557?v=4"},"body":"All options listed after \"-u[], --untracked-files[=]\" in the\ngit-commit(1) manpage ended up listed as though they were part of the\ndescription for -u/--untracked-files. This was introduced by d6293d1.\n\nSigned-off-by: Jacob Helwig \n---\n\nEver since the \"See linkgit:git-config[1]...\" paragraph was added to the\ndescription for the --untracked-files option (d6293d1), the paragraphs\nfor the following options were indented at the same level as the \"See\nlinkgit:git-config[1]\" paragraph. This problem looks like it only\nshowed up in the manpages, not in the HTML documentation.\n\nI'm not entirely happy with this patch, since the \"See linkgit...\"\nparagraph does not retain its previous indentation level in the\nmanpages, or HTML documentation.\n\nUnfortunately, I'm not very good with ASCIIDOC at all, so this is mainly\nthe result of me throwing things at the problem until I found something\nthat (mostly) works. Hopefully this will be enough to grab the\nattention of someone that's better with ASCIIDOC than I.\n\n Documentation/git-commit.txt | 6 +++---\n 1 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex e99bb14..64fb458 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -197,13 +197,13 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \tShow untracked files (Default: 'all').\n +\n The mode parameter is optional, and is used to specify\n-the handling of untracked files. The possible options are:\n+the handling of untracked files.\n++\n+The possible options are:\n +\n---\n \t- 'no' - Show no untracked files\n \t- 'normal' - Shows untracked files and directories\n \t- 'all' - Also shows individual files in untracked directories.\n---\n +\n See linkgit:git-config[1] for configuration variable\n used to change the default for when the option is not\n-- \n1.7.0\n"},{"id":"134633","messageId":"201002151008.31980.trast@student.ethz.ch","threadId":"22658","inReplyTo":"1266194717-25438-1-git-send-email-jacob.helwig@gmail.com","subject":"Re: [PATCH] Documentation: Fix indentation problem in git-commit(1)","fromName":"Thomas Rast","fromEmail":"trast@student.ethz.ch","sentAt":"2010-02-15T09:08:31Z","receivedAt":"2010-02-15T09:08:31Z","isPatch":true,"sender":{"key":"tr@thomasrast.ch","avatar":"https://avatars.githubusercontent.com/u/153510?v=4"},"body":"On Monday 15 February 2010 01:45:17 Jacob Helwig wrote:\n> All options listed after \"-u[], --untracked-files[=]\" in the\n> git-commit(1) manpage ended up listed as though they were part of the\n> description for -u/--untracked-files. This was introduced by d6293d1.\n\nWow. I once spent something that felt like an hour fiddling with\ndifferent options and eventually just gave up without results.\n\nI think the caveat\n\n> I'm not entirely happy with this patch, since the \"See linkgit...\"\n> paragraph does not retain its previous indentation level in the\n> manpages, or HTML documentation.\n\nshould go into the commit message in some form, but it's definitely an\nimprovement either way.\n\nSo,\n\nAcked-by: Thomas Rast \n\n-- \nThomas Rast\ntrast@{inf,student}.ethz.ch\n"},{"id":"134638","messageId":"1266237186-8065-1-git-send-email-jacob.helwig@gmail.com","threadId":"22658","inReplyTo":"201002151008.31980.trast@student.ethz.ch","subject":"[PATCH v2] Documentation: Fix indentation problem in git-commit(1)","fromName":"Jacob Helwig","fromEmail":"jacob.helwig@gmail.com","sentAt":"2010-02-15T12:33:06Z","receivedAt":"2010-02-15T12:33:06Z","isPatch":true,"sender":{"key":"jacob.helwig@gmail.com","avatar":"https://avatars.githubusercontent.com/u/14557?v=4"},"body":"Ever since the \"See linkgit:git-config[1]...\" paragraph was added to the\ndescription for --untracked-files (d6293d1), the paragraphs for the\nfollowing options were indented at the same level as the \"See\nlinkgit:git-config[1]\" paragraph. This problem showed up in the\nmanpages, but not in the HTML documentation.\n\nWhile this does fix the alignment of the options following\n--untracked-files in the manpage, the \"See linkgit...\" portion of the\ndescription does not retain its previous indentation level in the\nmanpages, or HTML documentation.\n\nSigned-off-by: Jacob Helwig \nAcked-by: Thomas Rast \n---\n\nWhen adding the caveat to the commit message, the introductory comment\nparagraph I had before seemed to fit better; I decided to go with a\nversion of it, instead.\n\n Documentation/git-commit.txt | 6 +++---\n 1 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex e99bb14..64fb458 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -197,13 +197,13 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \tShow untracked files (Default: 'all').\n +\n The mode parameter is optional, and is used to specify\n-the handling of untracked files. The possible options are:\n+the handling of untracked files.\n++\n+The possible options are:\n +\n---\n \t- 'no' - Show no untracked files\n \t- 'normal' - Shows untracked files and directories\n \t- 'all' - Also shows individual files in untracked directories.\n---\n +\n See linkgit:git-config[1] for configuration variable\n used to change the default for when the option is not\n-- \n1.7.0\n"},{"id":"135103","messageId":"20100219175411.GA388@vfb-9.home","threadId":"22658","inReplyTo":"1266237186-8065-1-git-send-email-jacob.helwig@gmail.com","subject":"Re: [PATCH v2] Documentation: Fix indentation problem in git-commit(1)","fromName":"Jacob Helwig","fromEmail":"jacob.helwig@gmail.com","sentAt":"2010-02-19T17:54:11Z","receivedAt":"2010-02-19T17:54:11Z","isPatch":true,"sender":{"key":"jacob.helwig@gmail.com","avatar":"https://avatars.githubusercontent.com/u/14557?v=4"},"body":"On 04:33 Mon 15 Feb , Jacob Helwig wrote:\n> Ever since the \"See linkgit:git-config[1]...\" paragraph was added to the\n> description for --untracked-files (d6293d1), the paragraphs for the\n> following options were indented at the same level as the \"See\n> linkgit:git-config[1]\" paragraph. This problem showed up in the\n> manpages, but not in the HTML documentation.\n> \n> While this does fix the alignment of the options following\n> --untracked-files in the manpage, the \"See linkgit...\" portion of the\n> description does not retain its previous indentation level in the\n> manpages, or HTML documentation.\n> \n> Signed-off-by: Jacob Helwig \n> Acked-by: Thomas Rast \n> ---\n> \n> When adding the caveat to the commit message, the introductory comment\n> paragraph I had before seemed to fit better; I decided to go with a\n> version of it, instead.\n> \n> Documentation/git-commit.txt | 6 +++---\n> 1 files changed, 3 insertions(+), 3 deletions(-)\n> \n> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\n> index e99bb14..64fb458 100644\n> --- a/Documentation/git-commit.txt\n> +++ b/Documentation/git-commit.txt\n> @@ -197,13 +197,13 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n> \tShow untracked files (Default: 'all').\n> +\n> The mode parameter is optional, and is used to specify\n> -the handling of untracked files. The possible options are:\n> +the handling of untracked files.\n> ++\n> +The possible options are:\n> +\n> ---\n> \t- 'no' - Show no untracked files\n> \t- 'normal' - Shows untracked files and directories\n> \t- 'all' - Also shows individual files in untracked directories.\n> ---\n> +\n> See linkgit:git-config[1] for configuration variable\n> used to change the default for when the option is not\n> -- \n> 1.7.0\n> \n\nI haven't seen any further discussion on this after I sent out a v2 with\nThomas's suggested change to the commit message, and I didn't want to\nlet the problem that this is trying to address fall through the cracks.\n\nDoes anyone have any comments on the v2 of this change?\n\n-- \nJacob Helwig\n"},{"id":"135142","messageId":"7vr5og4gs9.fsf@alter.siamese.dyndns.org","threadId":"22658","inReplyTo":"1266237186-8065-1-git-send-email-jacob.helwig@gmail.com","subject":"Re: [PATCH v2] Documentation: Fix indentation problem in git-commit(1)","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2010-02-20T05:28:38Z","receivedAt":"2010-02-20T05:28:38Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jacob Helwig writes:\n\n> Ever since the \"See linkgit:git-config[1]...\" paragraph was added to the\n> description for --untracked-files (d6293d1), the paragraphs for the\n> following options were indented at the same level as the \"See\n> linkgit:git-config[1]\" paragraph. This problem showed up in the\n> manpages, but not in the HTML documentation.\n\nI've never noticed it myself, but options after -u do align incorrectly in\nthe manpage rendered on FC11 (asciidoc 8.2.5, xmoto 0.0.22) or on FreeBSD8\n(asciidoc 8.4.5, xmlto 0.0.21) without your patch, and your patch seems to\nfix it on both of them.\n\nYour patch does not make any difference in my primary environment (Debian\n5 with asciidoc 8.2.7, xmlto 0.0.20), by the way. The options have the\nsame indentation level, with or without your patch. Your patch does not\nmake things worse, so that is Ok.\n\nThe \"See git-config(1)\" paragraph itself is indented too deeply, to align\nthe last bullet item (all). which does look wrong. This is true on all\nmachines I tried, and your patch does not improve nor worsen this.\n\nWhen output on Debian 5 (but not FC11 nor FBSD) is rendered to ps/pdf, the\nbullets alone align with '-u', which is also wrong. Your patch does not\nimprove nor worsen this.\n"}]}