Documentation: describe the "repository" in repository-layout
Update the introductory part and concisely explain how gitfile is handled, what it is used for and for what effect. Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
19b4d3d4ff
commit
7a7d05b62e
@ -12,12 +12,24 @@ $GIT_DIR/*
|
|||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
You may find these things in your Git repository (`.git`
|
A Git repository comes in two different flavours:
|
||||||
directory for a repository associated with your working tree, or
|
|
||||||
`<project>.git` directory for a public 'bare' repository. It is
|
* a `.git` directory at the root of the working tree;
|
||||||
also possible to have a working tree where `.git` is a plain
|
|
||||||
ASCII file containing `gitdir: <path>`, i.e. the path to the
|
* a `<project>.git` directory that is a 'bare' repository
|
||||||
real Git repository).
|
(i.e. without its own working tree), that is typically used for
|
||||||
|
exchanging histories with others by pushing into it and fetching
|
||||||
|
from it.
|
||||||
|
|
||||||
|
*Note*: Also you can have a plain text file `.git` at the root of
|
||||||
|
your working tree, containing `gitdir: <path>` to point at the real
|
||||||
|
directory that has the repository. This mechanism is often used for
|
||||||
|
a working tree of a submodule checkout, to allow you in the
|
||||||
|
containing superproject to `git checkout` a branch that does not
|
||||||
|
have the submodule. The `checkout` has to remove the entire
|
||||||
|
submodule working tree, without losing the submodule repository.
|
||||||
|
|
||||||
|
These things may exist in a Git repository.
|
||||||
|
|
||||||
objects::
|
objects::
|
||||||
Object store associated with this repository. Usually
|
Object store associated with this repository. Usually
|
||||||
|
Loading…
Reference in New Issue
Block a user