{"thread":{"id":"50969","subject":"[PATCH] doc/ls-files: put nested list for \"-t\" option into block","startedAt":"2019-04-22T15:15:44Z","lastAt":"2019-04-24T02:03:19Z","messageCount":3,"participants":["Jeff King","Junio C Hamano","Todd Zullinger"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"374245","messageId":"20190422151541.GA1633@sigill.intra.peff.net","threadId":"50969","inReplyTo":null,"subject":"[PATCH] doc/ls-files: put nested list for \"-t\" option into block","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2019-04-22T15:15:41Z","receivedAt":"2019-04-22T15:15:44Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"The description for the \"-t\" option contains a sub-list of all of the\npossible file status outputs. But because of the newline separating that\nlist from the description paragraph, asciidoc treats the sub-list\nentries as a continuation of the overall options list, rather than as\nchildren of the \"-t\" description.\n\nWe could fix it by adding a \"+\" before the sub-list to connect it to the\nrest of the \"-t\" text. But using a pair of \"--\" to delimit the block is\nperhaps more readable, and may have better compatibility with\nasciidoctor, as in 39a869b2f2 (Documentation/rev-list-options: wrap\n--date= block with \"--\", 2019-03-30).\n\nThe extra blank line comes from 5bc0e247c4 (Document ls-files -t as\nsemi-obsolete., 2010-07-28), but the problem actually seems older than\nthat. Before then, we did:\n\n -t:: some text...\n H:: cached\n M:: unmerged\n etc...\n\nbut asciidoc also treats that as one big list. So this problem seems to\nhave been around forever.\n\nSigned-off-by: Jeff King \n---\nJunio: I happened to notice this while hunting for \"ls-files\" options\n that could make your makefile de-dup patch unnecessary (but\n didn't find anything).\n\nTodd: Just an FYI that your \"--\" strategy is spreading. :)\n\n Documentation/git-ls-files.txt | 2 ++\n 1 file changed, 2 insertions(+)\n\ndiff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt\nindex 5298f1bc30..8461c0e83e 100644\n--- a/Documentation/git-ls-files.txt\n+++ b/Documentation/git-ls-files.txt\n@@ -118,6 +118,7 @@ OPTIONS\n \tlinkgit:git-status[1] `--short` or linkgit:git-diff[1]\n \t`--name-status` for more user-friendly alternatives.\n +\n+--\n This option identifies the file status with the following tags (followed by\n a space) at the start of each line:\n \n@@ -128,6 +129,7 @@ a space) at the start of each line:\n \tC::\tmodified/changed\n \tK::\tto be killed\n \t?::\tother\n+--\n \n -v::\n \tSimilar to `-t`, but use lowercase letters for files\n-- \n2.21.0.1180.g837af34674\n"},{"id":"374283","messageId":"xmqqzhoh5x98.fsf@gitster-ct.c.googlers.com","threadId":"50969","inReplyTo":"20190422151541.GA1633@sigill.intra.peff.net","subject":"Re: [PATCH] doc/ls-files: put nested list for \"-t\" option into block","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-04-23T01:24:51Z","receivedAt":"2019-04-23T01:24:56Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jeff King writes:\n\n> We could fix it by adding a \"+\" before the sub-list to connect it to the\n> rest of the \"-t\" text. But using a pair of \"--\" to delimit the block is\n> perhaps more readable, and may have better compatibility with\n> asciidoctor, as in 39a869b2f2 (Documentation/rev-list-options: wrap\n> --date= block with \"--\", 2019-03-30).\n\nOK, thanks.\n\n> Junio: I happened to notice this while hunting for \"ls-files\" options\n> that could make your makefile de-dup patch unnecessary (but\n> didn't find anything).\n\nYup, I was looking at builtin/ls-files.c before sending the Makefile\npatch, too ;-)\n\n> Documentation/git-ls-files.txt | 2 ++\n> 1 file changed, 2 insertions(+)\n>\n> diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt\n> index 5298f1bc30..8461c0e83e 100644\n> --- a/Documentation/git-ls-files.txt\n> +++ b/Documentation/git-ls-files.txt\n> @@ -118,6 +118,7 @@ OPTIONS\n> \tlinkgit:git-status[1] `--short` or linkgit:git-diff[1]\n> \t`--name-status` for more user-friendly alternatives.\n> +\n> +--\n> This option identifies the file status with the following tags (followed by\n> a space) at the start of each line:\n> \n> @@ -128,6 +129,7 @@ a space) at the start of each line:\n> \tC::\tmodified/changed\n> \tK::\tto be killed\n> \t?::\tother\n> +--\n> \n> -v::\n> \tSimilar to `-t`, but use lowercase letters for files\n"},{"id":"374362","messageId":"20190424020313.GP3654@pobox.com","threadId":"50969","inReplyTo":"20190422151541.GA1633@sigill.intra.peff.net","subject":"Re: [PATCH] doc/ls-files: put nested list for \"-t\" option into block","fromName":"Todd Zullinger","fromEmail":"tmz@pobox.com","sentAt":"2019-04-24T02:03:13Z","receivedAt":"2019-04-24T02:03:19Z","isPatch":true,"sender":{"key":"tmz@pobox.com","avatar":"https://avatars.githubusercontent.com/u/806319?v=4"},"body":"Hi,\n\nJeff King wrote:\n> The description for the \"-t\" option contains a sub-list of all of the\n> possible file status outputs. But because of the newline separating that\n> list from the description paragraph, asciidoc treats the sub-list\n> entries as a continuation of the overall options list, rather than as\n> children of the \"-t\" description.\n> \n> We could fix it by adding a \"+\" before the sub-list to connect it to the\n> rest of the \"-t\" text. But using a pair of \"--\" to delimit the block is\n> perhaps more readable, and may have better compatibility with\n> asciidoctor, as in 39a869b2f2 (Documentation/rev-list-options: wrap\n> --date= block with \"--\", 2019-03-30).\n> \n> The extra blank line comes from 5bc0e247c4 (Document ls-files -t as\n> semi-obsolete., 2010-07-28), but the problem actually seems older than\n> that. Before then, we did:\n> \n> -t:: some text...\n> H:: cached\n> M:: unmerged\n> etc...\n> \n> but asciidoc also treats that as one big list. So this problem seems to\n> have been around forever.\n> \n> Signed-off-by: Jeff King \n> ---\n> Junio: I happened to notice this while hunting for \"ls-files\" options\n> that could make your makefile de-dup patch unnecessary (but\n> didn't find anything).\n> \n> Todd: Just an FYI that your \"--\" strategy is spreading. :)\n\nHeh, cool. This is an obviously simple fix, but for good\nmeasure I checked the results with asciidoc 8.6.10 as well\nas asciidoctor 1.5.6 and 2.0.8. The output from each of\nthem looks good.\n\n-- \nTodd\n"}]}