{"thread":{"id":"13722","subject":"[PATCH] Documentation: convert \"glossary\" and \"core-tutorial\" to man pages","startedAt":"2008-05-29T17:21:46Z","lastAt":"2008-05-29T18:39:13Z","messageCount":2,"participants":["Christian Couder","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"78062","messageId":"20080529192146.20bb0f09.chriscool@tuxfamily.org","threadId":"13722","inReplyTo":null,"subject":"[PATCH] Documentation: convert \"glossary\" and \"core-tutorial\" to man pages","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-05-29T17:21:46Z","receivedAt":"2008-05-29T17:21:46Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"This patch renames the following documents and at the same time converts\nthem to the man format:\n\ncore-tutorial.txt -> gitcore-tutorial.txt\nglossary.txt      -> gitglossary.txt\n\nBut as the glossary is included in the user manual and as the new\ngitglossary man page cannot be included as a whole in the user manual,\nthe actual glossary content is now in its own \"glossary-content.txt\"\nnew file. And this file is included by both the user manual and the\ngitglossary man page.\n\nOther documents that reference the above ones are changed accordingly\nand sometimes improved a little too.\n\nSigned-off-by: Christian Couder <chriscool@tuxfamily.org>\n---\n Documentation/Makefile                             |    6 +---\n Documentation/git.txt                              |   13 +++++++--\n .../{core-tutorial.txt => gitcore-tutorial.txt}    |   26 ++++++++++++++++---\n Documentation/gitcvs-migration.txt                 |    7 ++++-\n Documentation/gitglossary.txt                      |   25 +++++++++++++++++++\n Documentation/gittutorial-2.txt                    |    8 ++++--\n Documentation/gittutorial.txt                      |    2 +\n .../{glossary.txt => glossary-content.txt}         |    3 --\n Documentation/user-manual.txt                      |    5 +++-\n 9 files changed, 75 insertions(+), 20 deletions(-)\n rename Documentation/{core-tutorial.txt => gitcore-tutorial.txt} (99%)\n create mode 100644 Documentation/gitglossary.txt\n rename Documentation/{glossary.txt => glossary-content.txt} (99%)\n\n\tBy the way I noticed that HTML files with the old name:\n\n\t- core-tutorial.html\n\t- tutorial.html\n\t- tutorial-2.html\n\n\tand their corresponding \".txt\" files are still in the \n\tAutogenerated HTML docs for v1.5.6-rc0-46-gd2b3:\n\nhttp://git.kernel.org/?p=git/git.git;a=tree;h=9049d9108c3a4c2198a349fb905ec4a70cd62306;hb=9049d9108c3a4c2198a349fb905ec4a70cd62306\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 9750334..ca4dadf 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -4,7 +4,7 @@ MAN1_TXT= \\\n \tgitk.txt\n MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt\n MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \\\n-\tgitcvs-migration.txt\n+\tgitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt\n \n MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)\n MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))\n@@ -12,13 +12,11 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))\n \n DOC_HTML=$(MAN_HTML)\n \n-ARTICLES = core-tutorial\n-ARTICLES += diffcore\n+ARTICLES = diffcore\n ARTICLES += howto-index\n ARTICLES += repository-layout\n ARTICLES += everyday\n ARTICLES += git-tools\n-ARTICLES += glossary\n # with their own formatting rules.\n SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual\n API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex c4b95af..d39ab57 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -174,7 +174,7 @@ See the references above to get started using git.  The following is\n probably more detail than necessary for a first-time user.\n \n The link:user-manual.html#git-concepts[git concepts chapter of the\n-user-manual] and the link:core-tutorial.html[Core tutorial] both provide\n+user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide\n introductions to the underlying git architecture.\n \n See also the link:howto-index.html[howto] documents for some useful\n@@ -374,7 +374,7 @@ Higher level SCMs may provide and manage additional information in the\n \n Terminology\n -----------\n-Please see the link:glossary.html[glossary] document.\n+Please see the linkgit:gitglossary[7][glossary] document.\n \n \n Environment Variables\n@@ -526,7 +526,7 @@ Discussion[[Discussion]]\n \n More detail on the following is available from the\n link:user-manual.html#git-concepts[git concepts chapter of the\n-user-manual] and the link:core-tutorial.html[Core tutorial].\n+user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial].\n \n A git project normally consists of a working directory with a \".git\"\n subdirectory at the top level.  The .git directory contains, among other\n@@ -587,6 +587,13 @@ The documentation for git suite was started by David Greaves\n <david@dgreaves.com>, and later enhanced greatly by the\n contributors on the git-list <git@vger.kernel.org>.\n \n+SEE ALSO\n+--------\n+linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n+linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],\n+link:user-manual.html[The Git User's Manual]\n+\n GIT\n ---\n Part of the linkgit:git[7] suite\ndiff --git a/Documentation/core-tutorial.txt b/Documentation/gitcore-tutorial.txt\nsimilarity index 99%\nrename from Documentation/core-tutorial.txt\nrename to Documentation/gitcore-tutorial.txt\nindex b50b5dd..5995a2e 100644\n--- a/Documentation/core-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -1,8 +1,16 @@\n-A git core tutorial for developers\n-==================================\n+gitcore-tutorial(7)\n+===================\n \n-Introduction\n-------------\n+NAME\n+----\n+gitcore-tutorial - A git core tutorial for developers\n+\n+SYNOPSIS\n+--------\n+git *\n+\n+DESCRIPTION\n+-----------\n \n This tutorial explains how to use the \"core\" git programs to set up and\n work with a git repository.\n@@ -1679,3 +1687,13 @@ merge two at a time, documenting how you resolved the conflicts,\n and the reason why you preferred changes made in one side over\n the other.  Otherwise it would make the project history harder\n to follow, not easier.\n+\n+SEE ALSO\n+--------\n+linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n+link:user-manual.html[The Git User's Manual]\n+\n+GIT\n+---\n+Part of the linkgit:git[7] suite.\ndiff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt\nindex c410805..de02a42 100644\n--- a/Documentation/gitcvs-migration.txt\n+++ b/Documentation/gitcvs-migration.txt\n@@ -20,7 +20,7 @@ this document explains how to do that.\n \n Some basic familiarity with git is required.  This\n linkgit:gittutorial[7][tutorial introduction to git] and the\n-link:glossary.html[git glossary] should be sufficient.\n+linkgit:gitglossary[7][git glossary] should be sufficient.\n \n Developing against a shared repository\n --------------------------------------\n@@ -184,7 +184,10 @@ repositories without the need for a central maintainer.\n \n SEE ALSO\n --------\n-linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n+linkgit:gittutorial[7],\n+linkgit:gittutorial-2[7],\n+linkgit:gitcore-tutorial[7],\n+linkgit:gitglossary[7],\n link:everyday.html[Everyday Git],\n link:user-manual.html[The Git User's Manual]\n \ndiff --git a/Documentation/gitglossary.txt b/Documentation/gitglossary.txt\nnew file mode 100644\nindex 0000000..e8475a0\n--- /dev/null\n+++ b/Documentation/gitglossary.txt\n@@ -0,0 +1,25 @@\n+gitglossary(7)\n+==============\n+\n+NAME\n+----\n+gitglossary - A GIT Glossary\n+\n+SYNOPSIS\n+--------\n+*\n+\n+DESCRIPTION\n+-----------\n+\n+include::glossary-content.txt[]\n+\n+SEE ALSO\n+--------\n+linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n+link:user-manual.html[The Git User's Manual]\n+\n+GIT\n+---\n+Part of the linkgit:git[7] suite.\ndiff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt\nindex 5bbbf43..4880ba9 100644\n--- a/Documentation/gittutorial-2.txt\n+++ b/Documentation/gittutorial-2.txt\n@@ -390,7 +390,7 @@ in the index file is identical to the one in the working directory.\n In addition to being the staging area for new commits, the index file\n is also populated from the object database when checking out a\n branch, and is used to hold the trees involved in a merge operation.\n-See the link:core-tutorial.html[core tutorial] and the relevant man\n+See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man\n pages for details.\n \n What next?\n@@ -400,7 +400,7 @@ At this point you should know everything necessary to read the man\n pages for any of the git commands; one good place to start would be\n with the commands mentioned in link:everyday.html[Everyday git].  You\n should be able to find any unknown jargon in the\n-link:glossary.html[Glossary].\n+linkgit:gitglossary[7][Glossary].\n \n The link:user-manual.html[Git User's Manual] provides a more\n comprehensive introduction to git.\n@@ -412,7 +412,7 @@ CVS-like way.\n For some interesting examples of git use, see the\n link:howto-index.html[howtos].\n \n-For git developers, the link:core-tutorial.html[Core tutorial] goes\n+For git developers, the linkgit:gitcore-tutorial[7][Core tutorial] goes\n into detail on the lower-level git mechanisms involved in, for\n example, creating a new commit.\n \n@@ -420,6 +420,8 @@ SEE ALSO\n --------\n linkgit:gittutorial[7],\n linkgit:gitcvs-migration[7],\n+linkgit:gitcore-tutorial[7],\n+linkgit:gitglossary[7],\n link:everyday.html[Everyday git],\n link:user-manual.html[The Git User's Manual]\n \ndiff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\nindex 898acdb..722b323 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -598,6 +598,8 @@ SEE ALSO\n --------\n linkgit:gittutorial-2[7],\n linkgit:gitcvs-migration[7],\n+linkgit:gitcore-tutorial[7],\n+linkgit:gitglossary[7],\n link:everyday.html[Everyday git],\n link:user-manual.html[The Git User's Manual]\n \ndiff --git a/Documentation/glossary.txt b/Documentation/glossary-content.txt\nsimilarity index 99%\nrename from Documentation/glossary.txt\nrename to Documentation/glossary-content.txt\nindex 51b6353..f981fee 100644\n--- a/Documentation/glossary.txt\n+++ b/Documentation/glossary-content.txt\n@@ -1,6 +1,3 @@\n-GIT Glossary\n-============\n-\n [[def_alternate_object_database]]alternate object database::\n \tVia the alternates mechanism, a <<def_repository,repository>>\n \tcan inherit part of its <<def_object_database,object database>>\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex fd8cdb6..bfde507 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -4252,7 +4252,10 @@ You see, Git is actually the best tool to find out about the source of Git\n itself!\n \n [[glossary]]\n-include::glossary.txt[]\n+GIT Glossary\n+============\n+\n+include::glossary-content.txt[]\n \n [[git-quick-start]]\n Appendix A: Git Quick Reference\n-- \n1.5.6.rc0.176.gb70e66\n"},{"id":"78077","messageId":"7vve0xneem.fsf@gitster.siamese.dyndns.org","threadId":"13722","inReplyTo":"20080529192146.20bb0f09.chriscool@tuxfamily.org","subject":"Re: [PATCH] Documentation: convert \"glossary\" and \"core-tutorial\" to man pages","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-05-29T18:39:13Z","receivedAt":"2008-05-29T18:39:13Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Christian Couder <chriscool@tuxfamily.org> writes:\n\n> \tBy the way I noticed that HTML files with the old name:\n>\n> \t- core-tutorial.html\n> \t- tutorial.html\n> \t- tutorial-2.html\n>\n> \tand their corresponding \".txt\" files are still in the \n> \tAutogenerated HTML docs for v1.5.6-rc0-46-gd2b3:\n\nThanks for letting me know --- I think you spotted a bug in dodoc.sh\nscript on 'todo' branch.  Unfortunately I won't have time to look into it\nright now...\n"}]}