{"thread":{"id":"3681","subject":"Re: [PATCH] Fix multi-paragraph list items in OPTIONS section","startedAt":"2006-03-20T10:41:18Z","lastAt":"2006-03-22T20:03:27Z","messageCount":2,"participants":["Francis Daly","Jonas Fonseca"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"17700","messageId":"20060320104118.GA32151@craic.sysops.org","threadId":"3681","inReplyTo":null,"subject":"Re: [PATCH] Fix multi-paragraph list items in OPTIONS section","fromName":"Francis Daly","fromEmail":"francis@daoine.org","sentAt":"2006-03-20T10:41:18Z","receivedAt":"2006-03-20T10:41:18Z","isPatch":true,"sender":{"key":"francis@daoine.org","avatar":null},"body":"On Mon, Mar 20, 2006 at 10:39:46, Jonas Fonseca wrote:\n\n> Asciidoc cannot handle multi-paragraph description list items without the\n> need for adding special control characters and reindenting all paragraphs\n> but the first. \n\nThis issue affects the display of current git-cvsimport and\ngit-svnimport doc pages. There was a general tidy-up done in\ndf8baa42fe4eeb5a021ac262caf601f44d2a5746 last October, but additions\nsince then didn't keep the layout.\n\nI don't think there is a full \"fix\" for this; either the html docs are\nugly (see the -A section in the pages mentioned above as they are now),\nor the asciidoc source files look odd (although that's probably not a\nbig problem) or the manpages look a bit funny.\n\nThis patch makes the html docs right, makes the asciidoc docs a bit odd\nbut consistent with what is there already, and makes the manpages look\nOK using docbook-xsl 1.68, but miss a paragraph separator when using 1.69.\n\nFor the manpages, current is like\n\n -A \n Read a file with lines on the form\n\n username = User's Full Name \n\n and use \"User's Full Name \" as the GIT\n\nWith this patch, docbook-xsl v1.68 looks like\n\n -A \n Read a file with lines on the form\n\n username = User's Full Name \n\n and use \"User's Full Name \" as the GIT author and\n\nwhile docbook-xsl v1.69 becomes\n\n -A \n Read a file with lines on the form\n\n username = User's Full Name \n and use \"User's Full Name \" as the GIT author and\n\nThe extra indentation is to keep the v1.69 manpage looking sane.\n\n---\ndiff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt\nindex 57027b4..b0c6d7c 100644\n--- a/Documentation/git-cvsimport.txt\n+++ b/Documentation/git-cvsimport.txt\n@@ -99,21 +99,24 @@ If you need to pass multiple options, se\n \tCVS by default uses the unix username when writing its\n \tcommit logs. Using this option and an author-conv-file\n \tin this format\n-\n++\n+---------\n \texon=Andreas Ericsson \n \tspawn=Simon Pawn \n \n-\tgit-cvsimport will make it appear as those authors had\n-\ttheir GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly\n-\tall along.\n-\n-\tFor convenience, this data is saved to $GIT_DIR/cvs-authors\n-\teach time the -A option is provided and read from that same\n-\tfile each time git-cvsimport is run.\n-\n-\tIt is not recommended to use this feature if you intend to\n-\texport changes back to CVS again later with\n-\tgit-link[1]::git-cvsexportcommit.\n+---------\n++\n+git-cvsimport will make it appear as those authors had\n+their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly\n+all along.\n++\n+For convenience, this data is saved to $GIT_DIR/cvs-authors\n+each time the -A option is provided and read from that same\n+file each time git-cvsimport is run.\n++\n+It is not recommended to use this feature if you intend to\n+export changes back to CVS again later with\n+git-link[1]::git-cvsexportcommit.\n \n OUTPUT\n ------\ndiff --git a/Documentation/git-svnimport.txt b/Documentation/git-svnimport.txt\nindex 9d38657..b1b87c2 100644\n--- a/Documentation/git-svnimport.txt\n+++ b/Documentation/git-svnimport.txt\n@@ -75,18 +75,21 @@ When importing incrementally, you might \n \n -A ::\n \tRead a file with lines on the form\n++\n+------\n+\tusername = User's Full Name \n \n-\t username = User's Full Name \n-\n-\tand use \"User's Full Name \" as the GIT\n-\tauthor and committer for Subversion commits made by\n-\t\"username\". If encountering a commit made by a user not in the\n-\tlist, abort.\n-\n-\tFor convenience, this data is saved to $GIT_DIR/svn-authors\n-\teach time the -A option is provided, and read from that same\n-\tfile each time git-svnimport is run with an existing GIT\n-\trepository without -A.\n+------\n++\n+and use \"User's Full Name \" as the GIT\n+author and committer for Subversion commits made by\n+\"username\". If encountering a commit made by a user not in the\n+list, abort.\n++\n+For convenience, this data is saved to $GIT_DIR/svn-authors\n+each time the -A option is provided, and read from that same\n+file each time git-svnimport is run with an existing GIT\n+repository without -A.\n \n -m::\n \tAttempt to detect merges based on the commit message. This option\n\n-- \nFrancis Daly francis@daoine.org\n"},{"id":"17779","messageId":"20060322200327.GA31324@diku.dk","threadId":"3681","inReplyTo":"20060320104118.GA32151@craic.sysops.org","subject":"Re: [PATCH] Fix multi-paragraph list items in OPTIONS section","fromName":"Jonas Fonseca","fromEmail":"fonseca@diku.dk","sentAt":"2006-03-22T20:03:27Z","receivedAt":"2006-03-22T20:03:27Z","isPatch":true,"sender":{"key":"fonseca@diku.dk","avatar":"https://gravatar.com/avatar/f82f3ad698717c51873b020c750a92438c820a24056dc39fe4d07baa10a92264?d=mp&s=160"},"body":"Francis Daly wrote Mon, Mar 20, 2006:\n> On Mon, Mar 20, 2006 at 10:39:46, Jonas Fonseca wrote:\n> \n> > Asciidoc cannot handle multi-paragraph description list items without the\n> > need for adding special control characters and reindenting all paragraphs\n> > but the first. \n> \n> This issue affects the display of current git-cvsimport and\n> git-svnimport doc pages. There was a general tidy-up done in\n> df8baa42fe4eeb5a021ac262caf601f44d2a5746 last October, but additions\n> since then didn't keep the layout.\n\nI think we are only a few people who cares about this and the vast\nnumber of git manpages makes it very time consuming to keep the layout\npolished. Personally, I care mostly for the git core manpages. Maybe if\nthey lived in a separate directory from the git porcelain manpages it\nwould be easier to get them into a better shape.\n\n> I don't think there is a full \"fix\" for this; either the html docs are\n> ugly (see the -A section in the pages mentioned above as they are now),\n> or the asciidoc source files look odd (although that's probably not a\n> big problem) or the manpages look a bit funny.\n\nI found the same thing. Getting both good HTML and manpages is not\ntrivial unless you use only limited and simple markup. Some things\nsupported by the HTML generator is not available or doesn't turn out as\ngood in the generated manpages. This was the main reason I decided to\nadd a special script to strip/convert markup when generating the cg-ref\nmanpages.\n\nAs for the odd looking asciidoc sources, you can always generate a clean\ntext version. BTW, for lists you can get rid of the '+' continuations\ntags by embedding the list in a pair of '--'. It makes the resulting\nsource a little more readable.\n\n\t--\n\t - item 1, para 1\n\t\n\titem 1, para 2\n\n\t - item 2\n\t--\n\n-- \nJonas Fonseca\n"}]}