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>
Christian Couder committed
Jun 6, 2008 at 09:07 UTC
30eba7bf2caa327b4251d66bf7157dda97512e96
8 files changed
+68
-20
Documentation/Makefile
+5
-5
@@ -2,9 +2,11 @@ MAN1_TXT= \
2
$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
3
$(wildcard git-*.txt)) \
4
gitk.txt
5
-MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
5
+MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
6
+ gitrepository-layout.txt
7
MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
7
- gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt
8
+ gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
9
+ gitdiffcore.txt
10
11
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
12
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@@ -12,9 +14,7 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
14
15
DOC_HTML=$(MAN_HTML)
16
15
-ARTICLES = diffcore
16
-ARTICLES += howto-index
17
-ARTICLES += repository-layout
17
+ARTICLES = howto-index
18
ARTICLES += everyday
19
ARTICLES += git-tools
20
# with their own formatting rules.
Documentation/diff-options.txt
+1
-1
@@ -241,4 +241,4 @@ endif::git-format-patch[]
241
Do not show any source or destination prefix.
242
243
For more detailed explanation on these common options, see also
244
-link:diffcore.html[diffcore documentation].
244
+linkgit:gitdiffcore[7][diffcore documentation].
Documentation/git-add.txt
+1
-1
@@ -100,7 +100,7 @@ Configuration
100
The optional configuration variable 'core.excludesfile' indicates a path to a
101
file containing patterns of file names to exclude from git-add, similar to
102
$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
103
-those in info/exclude. See link:repository-layout.html[repository layout].
103
+those in info/exclude. See linkgit:gitrepository-layout[5][repository layout].
104
105
106
EXAMPLES
Documentation/git-update-server-info.txt
+2
-2
@@ -30,8 +30,8 @@ OUTPUT
30
------
31
32
Currently the command updates the following files. Please see
33
-link:repository-layout.html[repository-layout] for description
34
-of what they are for:
33
+linkgit:gitrepository-layout[5][repository-layout] for description of
34
+what they are for:
35
36
* objects/info/packs
37
Documentation/git.txt
+2
-1
@@ -364,7 +364,8 @@ For a more complete list of ways to spell object names, see
364
File/Directory Structure
365
------------------------
366
367
-Please see the link:repository-layout.html[repository layout] document.
367
+Please see the linkgit:gitrepository-layout[5][repository layout]
368
+document.
369
370
Read linkgit:githooks[5][hooks] for more details about each hook.
371
Documentation/gitcore-tutorial.txt
+1
-1
@@ -109,7 +109,7 @@ populating your tree.
109
110
[NOTE]
111
An advanced user may want to take a look at the
112
-link:repository-layout.html[repository layout] document
112
+linkgit:gitrepository-layout[5][repository layout] document
113
after finishing this tutorial.
114
115
You have now created your first git repository. Of course, since it's
Documentation/gitdiffcore.txt
renamed
+26
-5
@@ -1,10 +1,16 @@
1
-Tweaking diff output
2
-====================
3
-June 2005
1
+gitdiffcore(7)
2
+==============
3
4
+NAME
5
+----
6
+gitdiffcore - Tweaking diff output (June 2005)
7
6
-Introduction
7
-------------
8
+SYNOPSIS
9
+--------
10
+git diff *
11
+
12
+DESCRIPTION
13
+-----------
14
15
The diff commands git-diff-index, git-diff-files, and git-diff-tree
16
can be told to manipulate differences they find in
@@ -269,3 +275,18 @@ Documentation
275
*.c
276
t
277
------------------------------------------------
278
+
279
+SEE ALSO
280
+--------
281
+linkgit:git-diff[1],
282
+linkgit:git-diff-files[1],
283
+linkgit:git-diff-index[1],
284
+linkgit:git-diff-tree[1],
285
+linkgit:git-format-patch[1],
286
+linkgit:git-log[1],
287
+linkgit:gitglossary[7],
288
+link:user-manual.html[The Git User's Manual]
289
+
290
+GIT
291
+---
292
+Part of the linkgit:git[7] suite.
Documentation/gitrepository-layout.txt
renamed
+30
-4
@@ -1,9 +1,20 @@
1
-git repository layout
2
-=====================
1
+gitrepository-layout(5)
2
+=======================
3
+
4
+NAME
5
+----
6
+gitrepository-layout - Git Repository Layout
7
+
8
+SYNOPSIS
9
+--------
10
+$GIT_DIR/*
11
+
12
+DESCRIPTION
13
+-----------
14
15
You may find these things in your git repository (`.git`
16
directory for a repository associated with your working tree, or
6
-`'project'.git` directory for a public 'bare' repository. It is
17
+`<project>.git` directory for a public 'bare' repository. It is
18
also possible to have a working tree where `.git` is a plain
19
ascii file containing `gitdir: <path>`, i.e. the path to the
20
real git repository).
@@ -115,7 +126,7 @@ details.
126
branches::
127
A slightly deprecated way to store shorthands to be used
128
to specify URL to `git fetch`, `git pull` and `git push`
118
- commands is to store a file in `branches/'name'` and
129
+ commands is to store a file in `branches/<name>` and
130
give 'name' to these commands in place of 'repository'
131
argument.
132
@@ -180,3 +191,18 @@ shallow::
191
This is similar to `info/grafts` but is internally used
192
and maintained by shallow clone mechanism. See `--depth`
193
option to linkgit:git-clone[1] and linkgit:git-fetch[1].
194
+
195
+SEE ALSO
196
+--------
197
+linkgit:git-init[1],
198
+linkgit:git-clone[1],
199
+linkgit:git-fetch[1],
200
+linkgit:git-pack-refs[1],
201
+linkgit:git-gc[1],
202
+linkgit:git-checkout[1],
203
+linkgit:gitglossary[7],
204
+link:user-manual.html[The Git User's Manual]
205
+
206
+GIT
207
+---
208
+Part of the linkgit:git[7] suite.