Browse Source

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>
maint
Christian Couder 17 years ago committed by Junio C Hamano
parent
commit
30eba7bf2c
  1. 10
      Documentation/Makefile
  2. 2
      Documentation/diff-options.txt
  3. 2
      Documentation/git-add.txt
  4. 4
      Documentation/git-update-server-info.txt
  5. 3
      Documentation/git.txt
  6. 2
      Documentation/gitcore-tutorial.txt
  7. 31
      Documentation/gitdiffcore.txt
  8. 34
      Documentation/gitrepository-layout.txt

10
Documentation/Makefile

@ -2,9 +2,11 @@ MAN1_TXT= \ @@ -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)) @@ -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.

2
Documentation/diff-options.txt

@ -241,4 +241,4 @@ endif::git-format-patch[] @@ -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].

2
Documentation/git-add.txt

@ -100,7 +100,7 @@ Configuration @@ -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

4
Documentation/git-update-server-info.txt

@ -30,8 +30,8 @@ OUTPUT @@ -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


3
Documentation/git.txt

@ -364,7 +364,8 @@ For a more complete list of ways to spell object names, see @@ -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.


2
Documentation/gitcore-tutorial.txt

@ -109,7 +109,7 @@ populating your tree. @@ -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

31
Documentation/diffcore.txt → Documentation/gitdiffcore.txt

@ -1,10 +1,16 @@ @@ -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 @@ -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.

34
Documentation/repository-layout.txt → Documentation/gitrepository-layout.txt

@ -1,9 +1,20 @@ @@ -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. @@ -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:: @@ -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.
Loading…
Cancel
Save