mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-10 06:26:13 +02:00
Code

Add gitmodules(5) 

This adds documentation for the .gitmodules file.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Lars Hjemli 2007-06-12 09:05:21 +02:00 committed by Junio C Hamano
parent 941987a554
commit 891dbc6e40
2 changed files with 63 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/Makefile
View File

@ -2,7 +2,7 @@ MAN1_TXT= \
$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
$(wildcard git-*.txt)) \
gitk.txt
MAN5_TXT=gitattributes.txt gitignore.txt
MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt
MAN7_TXT=git.txt
DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))

62
Documentation/gitmodules.txt Normal file
View File

@ -0,0 +1,62 @@
gitmodules(5)
=============
NAME
----
gitmodules - defining submodule properties
SYNOPSIS
--------
.gitmodules
DESCRIPTION
-----------
The `.gitmodules` file, located in the top-level directory of a git
working tree, is a text file with a syntax matching the requirements
of gitlink:git-config[1].
The file contains one subsection per submodule, and the subsection value
is the name of the submodule. Each submodule section also contains the
following required keys:
submodule.<name>.path::
Defines the path, relative to the top-level directory of the git
working tree, where the submodule is expected to be checked out.
The path name must not end with a `/`. All submodule paths must
be unique within the .gitmodules file.
submodule.<name>.url::
Defines an url from where the submodule repository can be cloned.
EXAMPLES
--------
Consider the following .gitmodules file:
[submodule "libfoo"]
path = include/foo
url = git://foo.com/git/lib.git
[submodule "libbar"]
path = include/bar
url = git://bar.com/git/lib.git
This defines two submodules, `libfoo` and `libbar`. These are expected to
be checked out in the paths 'include/foo' and 'include/bar', and for both
submodules an url is specified which can be used for cloning the submodules.
SEE ALSO
--------
gitlink:git-submodule[1] gitlink:git-config[1]
DOCUMENTATION
-------------
Documentation by Lars Hjemli <hjemli@gmail.com>
GIT
---
Part of the gitlink:git[7] suite