summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Couder <chriscool@tuxfamily.org>2008-06-06 09:07:28 +0200
committerJunio C Hamano <gitster@pobox.com>2008-06-06 11:14:52 -0700
commit30eba7bf2caa327b4251d66bf7157dda97512e96 (patch)
tree37326a19bfc12c78ce12cf2ddbafd18bb187d513
parenta0ebe573a516a1530a2c072e513fa7f529781dd0 (diff)
downloadgit-30eba7bf2caa327b4251d66bf7157dda97512e96.tar.gz
documentation: convert "diffcore" and "repository-layout" to man pages
This patch renames the following documents and at the same time converts them to the man format: diffcore.txt -> gitdiffcore.txt (man section 7) repository-layout.txt -> gitrepository-layout.txt (man section 5) Other documents that reference the above ones are changed accordingly. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/Makefile10
-rw-r--r--Documentation/diff-options.txt2
-rw-r--r--Documentation/git-add.txt2
-rw-r--r--Documentation/git-update-server-info.txt4
-rw-r--r--Documentation/git.txt3
-rw-r--r--Documentation/gitcore-tutorial.txt2
-rw-r--r--Documentation/gitdiffcore.txt (renamed from Documentation/diffcore.txt)31
-rw-r--r--Documentation/gitrepository-layout.txt (renamed from Documentation/repository-layout.txt)34
8 files changed, 68 insertions, 20 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index ca4dadf940..5bd0e7c76e 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -2,9 +2,11 @@ MAN1_TXT= \
$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
$(wildcard git-*.txt)) \
gitk.txt
-MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
+MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
+ gitrepository-layout.txt
MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
- gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt
+ gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
+ gitdiffcore.txt
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@@ -12,9 +14,7 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
DOC_HTML=$(MAN_HTML)
-ARTICLES = diffcore
-ARTICLES += howto-index
-ARTICLES += repository-layout
+ARTICLES = howto-index
ARTICLES += everyday
ARTICLES += git-tools
# with their own formatting rules.
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 859d67990a..572154834b 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -241,4 +241,4 @@ endif::git-format-patch[]
Do not show any source or destination prefix.
For more detailed explanation on these common options, see also
-link:diffcore.html[diffcore documentation].
+linkgit:gitdiffcore[7][diffcore documentation].
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 1afd0c69ed..8eb9de11c2 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -100,7 +100,7 @@ Configuration
The optional configuration variable 'core.excludesfile' indicates a path to a
file containing patterns of file names to exclude from git-add, similar to
$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
-those in info/exclude. See link:repository-layout.html[repository layout].
+those in info/exclude. See linkgit:gitrepository-layout[5][repository layout].
EXAMPLES
diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt
index 1cf89fd79e..b49abbf43f 100644
--- a/Documentation/git-update-server-info.txt
+++ b/Documentation/git-update-server-info.txt
@@ -30,8 +30,8 @@ OUTPUT
------
Currently the command updates the following files. Please see
-link:repository-layout.html[repository-layout] for description
-of what they are for:
+linkgit:gitrepository-layout[5][repository-layout] for description of
+what they are for:
* objects/info/packs
diff --git a/Documentation/git.txt b/Documentation/git.txt
index dae1b4031c..f0d106addf 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -364,7 +364,8 @@ For a more complete list of ways to spell object names, see
File/Directory Structure
------------------------
-Please see the link:repository-layout.html[repository layout] document.
+Please see the linkgit:gitrepository-layout[5][repository layout]
+document.
Read linkgit:githooks[5][hooks] for more details about each hook.
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index 5995a2e152..d61d5c96cc 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -109,7 +109,7 @@ populating your tree.
[NOTE]
An advanced user may want to take a look at the
-link:repository-layout.html[repository layout] document
+linkgit:gitrepository-layout[5][repository layout] document
after finishing this tutorial.
You have now created your first git repository. Of course, since it's
diff --git a/Documentation/diffcore.txt b/Documentation/gitdiffcore.txt
index c6a983a5d5..f68efed4c3 100644
--- a/Documentation/diffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -1,10 +1,16 @@
-Tweaking diff output
-====================
-June 2005
+gitdiffcore(7)
+==============
+NAME
+----
+gitdiffcore - Tweaking diff output (June 2005)
-Introduction
-------------
+SYNOPSIS
+--------
+git diff *
+
+DESCRIPTION
+-----------
The diff commands git-diff-index, git-diff-files, and git-diff-tree
can be told to manipulate differences they find in
@@ -269,3 +275,18 @@ Documentation
*.c
t
------------------------------------------------
+
+SEE ALSO
+--------
+linkgit:git-diff[1],
+linkgit:git-diff-files[1],
+linkgit:git-diff-index[1],
+linkgit:git-diff-tree[1],
+linkgit:git-format-patch[1],
+linkgit:git-log[1],
+linkgit:gitglossary[7],
+link:user-manual.html[The Git User's Manual]
+
+GIT
+---
+Part of the linkgit:git[7] suite.
diff --git a/Documentation/repository-layout.txt b/Documentation/gitrepository-layout.txt
index 7fd187be8a..9949093845 100644
--- a/Documentation/repository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -1,9 +1,20 @@
-git repository layout
-=====================
+gitrepository-layout(5)
+=======================
+
+NAME
+----
+gitrepository-layout - Git Repository Layout
+
+SYNOPSIS
+--------
+$GIT_DIR/*
+
+DESCRIPTION
+-----------
You may find these things in your git repository (`.git`
directory for a repository associated with your working tree, or
-`'project'.git` directory for a public 'bare' repository. It is
+`<project>.git` directory for a public 'bare' repository. It is
also possible to have a working tree where `.git` is a plain
ascii file containing `gitdir: <path>`, i.e. the path to the
real git repository).
@@ -115,7 +126,7 @@ details.
branches::
A slightly deprecated way to store shorthands to be used
to specify URL to `git fetch`, `git pull` and `git push`
- commands is to store a file in `branches/'name'` and
+ commands is to store a file in `branches/<name>` and
give 'name' to these commands in place of 'repository'
argument.
@@ -180,3 +191,18 @@ shallow::
This is similar to `info/grafts` but is internally used
and maintained by shallow clone mechanism. See `--depth`
option to linkgit:git-clone[1] and linkgit:git-fetch[1].
+
+SEE ALSO
+--------
+linkgit:git-init[1],
+linkgit:git-clone[1],
+linkgit:git-fetch[1],
+linkgit:git-pack-refs[1],
+linkgit:git-gc[1],
+linkgit:git-checkout[1],
+linkgit:gitglossary[7],
+link:user-manual.html[The Git User's Manual]
+
+GIT
+---
+Part of the linkgit:git[7] suite.