{"thread":{"id":"13374","subject":"[PATCH] Documentation: convert \"diffcore\" and \"repository-layout\" to man pages","startedAt":"2008-05-04T16:34:33Z","lastAt":"2008-05-04T17:13:52Z","messageCount":2,"participants":["Christian Couder","Jakub Narebski"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"76027","messageId":"20080504183433.baf3058e.chriscool@tuxfamily.org","threadId":"13374","inReplyTo":null,"subject":"[PATCH] Documentation: convert \"diffcore\" and \"repository-layout\" to man pages","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-05-04T16:34:33Z","receivedAt":"2008-05-04T16:34:33Z","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\ndifcore.txt           -> gitdiffcore.txt\nrepository-layout.txt -> gitrepository-layout.txt\n\nOther documents that reference the above ones are changed accordingly.\n---\n Documentation/Makefile                             |    7 ++--\n Documentation/diff-options.txt                     |    2 +-\n Documentation/git-add.txt                          |    2 +-\n Documentation/git-update-server-info.txt           |    4 +-\n Documentation/git.txt                              |    3 +-\n Documentation/gitcore-tutorial.txt                 |    2 +-\n Documentation/{diffcore.txt => gitdiffcore.txt}    |   31 +++++++++++++++---\n ...ository-layout.txt => gitrepository-layout.txt} |   34 +++++++++++++++++--\n 8 files changed, 66 insertions(+), 19 deletions(-)\n rename Documentation/{diffcore.txt => gitdiffcore.txt} (96%)\n rename Documentation/{repository-layout.txt => gitrepository-layout.txt} (92%)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 5ec7bd8..29f41a8 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -2,7 +2,8 @@ MAN1_TXT= \\\n \t$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \\\n \t\t$(wildcard git-*.txt)) \\\n \tgitk.txt\n-MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt\n+MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \\\n+\tgitdiffcore.txt gitrepository-layout.txt\n MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \\\n \tgitcvs-migration.txt giteveryday.txt gitcore-tutorial.txt \\\n \tgitglossary.txt\n@@ -13,9 +14,7 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))\n \n DOC_HTML=$(MAN_HTML)\n \n-ARTICLES = diffcore\n-ARTICLES += howto-index\n-ARTICLES += repository-layout\n+ARTICLES = howto-index\n ARTICLES += git-tools\n # with their own formatting rules.\n SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 13234fa..d1d2864 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -238,4 +238,4 @@ endif::git-format-patch[]\n \tDo not show any source or destination prefix.\n \n For more detailed explanation on these common options, see also\n-link:diffcore.html[diffcore documentation].\n+linkgit:gitdiffcore[5][diffcore documentation].\ndiff --git a/Documentation/git-add.txt b/Documentation/git-add.txt\nindex 35e67a0..89d5632 100644\n--- a/Documentation/git-add.txt\n+++ b/Documentation/git-add.txt\n@@ -93,7 +93,7 @@ Configuration\n The optional configuration variable 'core.excludesfile' indicates a path to a\n file containing patterns of file names to exclude from git-add, similar to\n $GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to\n-those in info/exclude.  See link:repository-layout.html[repository layout].\n+those in info/exclude.  See linkgit:gitrepository-layout[5][repository layout].\n \n \n EXAMPLES\ndiff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt\nindex 1cf89fd..b49abbf 100644\n--- a/Documentation/git-update-server-info.txt\n+++ b/Documentation/git-update-server-info.txt\n@@ -30,8 +30,8 @@ OUTPUT\n ------\n \n Currently the command updates the following files.  Please see\n-link:repository-layout.html[repository-layout] for description\n-of what they are for:\n+linkgit:gitrepository-layout[5][repository-layout] for description of\n+what they are for:\n \n * objects/info/packs\n \ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 855e90e..1e3c09f 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -362,7 +362,8 @@ For a more complete list of ways to spell object names, see\n File/Directory Structure\n ------------------------\n \n-Please see the link:repository-layout.html[repository layout] document.\n+Please see the linkgit:gitrepository-layout[5][repository layout]\n+document.\n \n Read linkgit:githooks[5][hooks] for more details about each hook.\n \ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex 5995a2e..d61d5c9 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -109,7 +109,7 @@ populating your tree.\n \n [NOTE]\n An advanced user may want to take a look at the\n-link:repository-layout.html[repository layout] document\n+linkgit:gitrepository-layout[5][repository layout] document\n after finishing this tutorial.\n \n You have now created your first git repository. Of course, since it's\ndiff --git a/Documentation/diffcore.txt b/Documentation/gitdiffcore.txt\nsimilarity index 96%\nrename from Documentation/diffcore.txt\nrename to Documentation/gitdiffcore.txt\nindex c6a983a..4e39d91 100644\n--- a/Documentation/diffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -1,10 +1,16 @@\n-Tweaking diff output\n-====================\n-June 2005\n+gitdiffcore(5)\n+==============\n \n+NAME\n+----\n+gitdiffcore - Tweaking diff output (June 2005)\n \n-Introduction\n-------------\n+SYNOPSIS\n+--------\n+git diff *\n+\n+DESCRIPTION\n+-----------\n \n The diff commands git-diff-index, git-diff-files, and git-diff-tree\n can be told to manipulate differences they find in\n@@ -269,3 +275,18 @@ Documentation\n *.c\n t\n ------------------------------------------------\n+\n+SEE ALSO\n+--------\n+linkgit:git-diff[1],\n+linkgit:git-diff-files[1],\n+linkgit:git-diff-index[1],\n+linkgit:git-diff-tree[1],\n+linkgit:git-format-patch[1],\n+linkgit:git-log[1],\n+linkgit:gitglossary[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/repository-layout.txt b/Documentation/gitrepository-layout.txt\nsimilarity index 92%\nrename from Documentation/repository-layout.txt\nrename to Documentation/gitrepository-layout.txt\nindex 7fd187b..9949093 100644\n--- a/Documentation/repository-layout.txt\n+++ b/Documentation/gitrepository-layout.txt\n@@ -1,9 +1,20 @@\n-git repository layout\n-=====================\n+gitrepository-layout(5)\n+=======================\n+\n+NAME\n+----\n+gitrepository-layout - Git Repository Layout\n+\n+SYNOPSIS\n+--------\n+$GIT_DIR/*\n+\n+DESCRIPTION\n+-----------\n \n You may find these things in your git repository (`.git`\n directory for a repository associated with your working tree, or\n-`'project'.git` directory for a public 'bare' repository. It is\n+`<project>.git` directory for a public 'bare' repository. It is\n also possible to have a working tree where `.git` is a plain\n ascii file containing `gitdir: <path>`, i.e. the path to the\n real git repository).\n@@ -115,7 +126,7 @@ details.\n branches::\n \tA slightly deprecated way to store shorthands to be used\n \tto specify URL to `git fetch`, `git pull` and `git push`\n-\tcommands is to store a file in `branches/'name'` and\n+\tcommands is to store a file in `branches/<name>` and\n \tgive 'name' to these commands in place of 'repository'\n \targument.\n \n@@ -180,3 +191,18 @@ shallow::\n \tThis is similar to `info/grafts` but is internally used\n \tand maintained by shallow clone mechanism.  See `--depth`\n \toption to linkgit:git-clone[1] and linkgit:git-fetch[1].\n+\n+SEE ALSO\n+--------\n+linkgit:git-init[1],\n+linkgit:git-clone[1],\n+linkgit:git-fetch[1],\n+linkgit:git-pack-refs[1],\n+linkgit:git-gc[1],\n+linkgit:git-checkout[1],\n+linkgit:gitglossary[7],\n+link:user-manual.html[The Git User's Manual]\n+\n+GIT\n+---\n+Part of the linkgit:git[7] suite.\n-- \n1.5.5.1.124.g7e5fa.dirty\n"},{"id":"76032","messageId":"200805041913.54900.jnareb@gmail.com","threadId":"13374","inReplyTo":"20080504183433.baf3058e.chriscool@tuxfamily.org","subject":"Re: [PATCH] Documentation: convert \"diffcore\" and \"repository-layout\" to man pages","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2008-05-04T17:13:52Z","receivedAt":"2008-05-04T17:13:52Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"On Sun, 4 May 2008, Christian Couder wrote:\n\n> This patch renames the following documents and at the same time converts\n> them to the man format:\n> \n> difcore.txt           -> gitdiffcore.txt\n> repository-layout.txt -> gitrepository-layout.txt\n\nI'd rather use git-repository-layout.txt\n\n-- \nJakub Narebski\nPoland\n"}]}