From: Lars Hjemli <hjemli@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Sven Verdoolaege <skimo@kotnet.org>,
git@vger.kernel.org
Subject: [PATCH 2/3] Add gitmodules(5)
Date: Sat, 9 Jun 2007 23:38:51 +0200 [thread overview]
Message-ID: <11814251322779-git-send-email-hjemli@gmail.com> (raw)
In-Reply-To: <1181425132239-git-send-email-hjemli@gmail.com>
This adds documentation for the .gitmodules file.
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
---
Documentation/Makefile | 2 +-
Documentation/gitmodules.txt | 63 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 64 insertions(+), 1 deletions(-)
create mode 100644 Documentation/gitmodules.txt
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 9cef480..2ad18e0 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -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))
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
new file mode 100644
index 0000000..37888c9
--- /dev/null
+++ b/Documentation/gitmodules.txt
@@ -0,0 +1,63 @@
+gitmodules(5)
+=============
+
+NAME
+----
+gitmodules - defining submodule properties
+
+SYNOPSIS
+--------
+.gitmodules
+
+
+DESCRIPTION
+-----------
+
+The `.gitmodules` file, located in the top-level directory of a
+gitlink:git[7] working tree, is a text file with a layout matching the
+requirements of gitlink:git-config[1].
+
+The file consists of sections named `module`, divided into one subsection
+per submodule. The subsections are named with the logical name of the
+submodule it describes.
+
+Each submodule can contain the following keys.
+
+module.$name.path::
+ Define a path, relative to the top-level directory of the git
+ working tree, where the submodule is expected to be checked out.
+
+module.$name.url::
+ Define a url from where the submodule repository can be cloned.
+
+
+EXAMPLES
+--------
+
+Consider the following .gitmodules file:
+
+ [module 'libfoo']
+ path = include/foo
+ url = git://example1.com/git/libfoo.git
+
+ [module 'libbar']
+ url = git://example2.com/pub/git/libbar.git
+
+
+This defines two submodules, `libfoo` and `libbar`. The former specifies
+both a checkout path and a suggested url, while the latter only specifies
+a url. This file would make gitlink:git-submodule[1] map the path
+`include/foo` to the submodule `libfoo` and the path `libbar` to the
+submodule `libbar`.
+
+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
--
1.5.2.1.914.gbd3a7
next prev parent reply other threads:[~2007-06-09 21:36 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-06-09 21:38 [PATCH 0/3] submodule improvements Lars Hjemli
2007-06-09 21:38 ` [PATCH 1/3] git-submodule: allow submodule name and path to differ Lars Hjemli
2007-06-10 0:27 ` Junio C Hamano
2007-06-10 7:25 ` Johannes Schindelin
2007-06-10 8:23 ` Junio C Hamano
2007-06-10 8:42 ` Lars Hjemli
2007-06-10 8:37 ` Lars Hjemli
2007-06-09 21:38 ` Lars Hjemli [this message]
2007-06-10 0:28 ` [PATCH 2/3] Add gitmodules(5) Frank Lichtenheld
2007-06-10 8:58 ` Lars Hjemli
2007-06-10 9:48 ` Johannes Schindelin
2007-06-10 10:10 ` Lars Hjemli
2007-06-10 12:12 ` Sven Verdoolaege
2007-06-10 12:30 ` Lars Hjemli
2007-06-10 12:40 ` Sven Verdoolaege
2007-06-10 12:51 ` Lars Hjemli
2007-06-10 20:57 ` Junio C Hamano
2007-06-10 21:14 ` Lars Hjemli
2007-06-11 8:34 ` Sven Verdoolaege
2007-06-11 10:47 ` Lars Hjemli
2007-06-11 11:04 ` Sven Verdoolaege
2007-06-11 16:17 ` Junio C Hamano
2007-06-13 15:36 ` Matthias Lederhofer
2007-06-13 16:13 ` Lars Hjemli
2007-06-13 16:31 ` Matthias Lederhofer
2007-06-13 16:59 ` Lars Hjemli
2007-06-13 16:20 ` Junio C Hamano
2007-06-13 22:01 ` [PATCH] gitmodules(5): remove leading period from synopsis Lars Hjemli
2007-06-09 21:38 ` [PATCH 3/3] t7400: barf if git-submodule removes or replaces a file Lars Hjemli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=11814251322779-git-send-email-hjemli@gmail.com \
--to=hjemli@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=skimo@kotnet.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).