{"thread":{"id":"16905","subject":"[PATCH 2/2] Fix the building of gitman.info document","startedAt":"2008-12-29T08:03:07Z","lastAt":"2008-12-29T08:39:48Z","messageCount":4,"participants":["Teemu Likonen","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"98867","messageId":"1230537789-5376-1-git-send-email-tlikonen@iki.fi","threadId":"16905","inReplyTo":null,"subject":"[PATCH 0/2] Fix the building of Info documents","fromName":"Teemu Likonen","fromEmail":"tlikonen@iki.fi","sentAt":"2008-12-29T08:03:07Z","receivedAt":"2008-12-29T08:03:07Z","isPatch":true,"sender":{"key":"tlikonen@iki.fi","avatar":null},"body":"In these days Info documents are probably only used by Emacs users. I'm\none, so I wanted to fix the building of Git Info documents. And it's\neven possible - to certain extent.\n\nMy real opinion is that the document conversion chain .txt - .xml -\n.texi - .info. just can't work without a miracle. These patches\ncertainly don't do a miracle but they allow building an usable Info\nversion of the user manual and the man pages. As usual, there are\nproblems with markup conversions. For example, two dashes (--) in a\n.texi file turn into one Ascii dash (-), so there are options like\n\"-interactive\" and \"-stat\" in the Info documents. I wouldn't advertise\nthese documents very loudly to the public.\n\n(My real real real opinion is that the GNU people should drop the Info\nsystem and start using html instead. Html probably isn't a simple\ndrop-in replacement but at least it's a relevant format in 2008-2009.)\n\n\nTeemu Likonen (2):\n Fix the building of user-manual.texi and gitman.texi documents\n Fix the building of gitman.info document\n\n Documentation/Makefile | 9 +++++----\n Documentation/cat-texi.perl | 8 ++++++--\n 2 files changed, 11 insertions(+), 6 deletions(-)\n"},{"id":"98866","messageId":"1230537789-5376-2-git-send-email-tlikonen@iki.fi","threadId":"16905","inReplyTo":"1230537789-5376-1-git-send-email-tlikonen@iki.fi","subject":"[PATCH 1/2] Fix the building of user-manual.texi and gitman.texi documents","fromName":"Teemu Likonen","fromEmail":"tlikonen@iki.fi","sentAt":"2008-12-29T08:03:08Z","receivedAt":"2008-12-29T08:03:08Z","isPatch":true,"sender":{"key":"tlikonen@iki.fi","avatar":null},"body":"Previously \"docbook2x-texi\" failed to generate user-manual.texi and\ngitman.texi files from .xml input files because \"iconv\" stopped at\n\"illegal input sequence\" error. This was due to some UTF-8 octets in the\ninput .xml files. This patch adds option --encoding=UTF-8 for\n\"docbook2x-texi\" to allow the building of .texi files complete.\n\nSigned-off-by: Teemu Likonen \n---\n Documentation/Makefile | 7 ++++---\n 1 files changed, 4 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex c34c1ca..c41a7b4 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -187,13 +187,14 @@ git.info: user-manual.texi\n \n user-manual.texi: user-manual.xml\n \t$(RM) $@+ $@\n-\t$(DOCBOOK2X_TEXI) user-manual.xml --to-stdout | $(PERL_PATH) fix-texi.perl >$@+\n+\t$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout | \\\n+\t\t$(PERL_PATH) fix-texi.perl >$@+\n \tmv $@+ $@\n \n gitman.texi: $(MAN_XML) cat-texi.perl\n \t$(RM) $@+ $@\n-\t($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --to-stdout $(xml);)) | \\\n-\t$(PERL_PATH) cat-texi.perl $@ >$@+\n+\t($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \\\n+\t\t--to-stdout $(xml);)) | $(PERL_PATH) cat-texi.perl $@ >$@+\n \tmv $@+ $@\n \n gitman.info: gitman.texi\n-- \n1.6.1.16.gd45c5\n"},{"id":"98865","messageId":"1230537789-5376-3-git-send-email-tlikonen@iki.fi","threadId":"16905","inReplyTo":"1230537789-5376-2-git-send-email-tlikonen@iki.fi","subject":"[PATCH 2/2] Fix the building of gitman.info document","fromName":"Teemu Likonen","fromEmail":"tlikonen@iki.fi","sentAt":"2008-12-29T08:03:09Z","receivedAt":"2008-12-29T08:03:09Z","isPatch":true,"sender":{"key":"tlikonen@iki.fi","avatar":null},"body":"\"makeinfo\" failed to generate gitman.info from gitman.texi input file\nbecause the combined manual page file contains several nodes with the\nsame name (DESCRIPTION, OPTIONS, SEE ALSO etc.). An Info document should\ncontain unique node names.\n\nThis patch creates a simple (read: ugly) work-around by suppressing the\nvalidation of the final Info file. Jumping to nodes in the Info document\nstill works but they are not very useful. Common man-page headings like\nDESCRIPTION and OPTIONS appear in the Info node list and they point to\nthe man page where they appear first (that is git-add currently).\n\nAlso, this patch adds directory-entry information for Info document to\nmake the document appear in the top-level Info directory.\n\nSigned-off-by: Teemu Likonen \n---\n Documentation/Makefile | 2 +-\n Documentation/cat-texi.perl | 8 ++++++--\n 2 files changed, 7 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex c41a7b4..5cd8b63 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -198,7 +198,7 @@ gitman.texi: $(MAN_XML) cat-texi.perl\n \tmv $@+ $@\n \n gitman.info: gitman.texi\n-\t$(MAKEINFO) --no-split $*.texi\n+\t$(MAKEINFO) --no-split --no-validate $*.texi\n \n $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml\n \t$(RM) $@+ $@\ndiff --git a/Documentation/cat-texi.perl b/Documentation/cat-texi.perl\nindex dbc133c..828ec62 100755\n--- a/Documentation/cat-texi.perl\n+++ b/Documentation/cat-texi.perl\n@@ -18,8 +18,12 @@ close TMP;\n \n printf '\\input texinfo\n @setfilename gitman.info\n-@documentencoding us-ascii\n-@node Top,,%s\n+@documentencoding UTF-8\n+@dircategory Development\n+@direntry\n+* Git Man Pages: (gitman). Manual pages for Git revision control system\n+@end direntry\n+@node Top,,, (dir)\n @top Git Manual Pages\n @documentlanguage en\n @menu\n-- \n1.6.1.16.gd45c5\n"},{"id":"98869","messageId":"7veizre5nv.fsf@gitster.siamese.dyndns.org","threadId":"16905","inReplyTo":"1230537789-5376-2-git-send-email-tlikonen@iki.fi","subject":"Re: [PATCH 1/2] Fix the building of user-manual.texi and gitman.texi documents","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-12-29T08:39:48Z","receivedAt":"2008-12-29T08:39:48Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"I do not build nor use info myself these days, so I'll apply the patches\nbut when somebody else screams I'll let you and that somebody else work on\nimprovements.\n\nThanks.\n"}]}