From: "Lars Hjemli" <hjemli@gmail.com>
To: "git@vger.kernel.org" <git@vger.kernel.org>
Subject: [PATCH 5/5] Add gitmodules(5)
Date: Mon, 11 Jun 2007 02:04:01 +0200 [thread overview]
Message-ID: <op.ttqc4znc9pspc6@localhost> (raw)
This adds documentation for the .gitmodules file.
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
---
Documentation/Makefile | 2 +-
Documentation/gitmodules.txt | 62 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 63 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..6c7d9bf
--- /dev/null
+++ b/Documentation/gitmodules.txt
@@ -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
--
1.5.2.1.914.gbd3a7
next reply other threads:[~2007-06-11 0:01 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-06-11 0:04 Lars Hjemli [this message]
-- strict thread matches above, loose matches on Subject: below --
2007-06-11 19:12 [PATCH 0/5] misc. submodule related changes Lars Hjemli
2007-06-11 19:12 ` [PATCH 1/5] t7400: barf if git-submodule removes or replaces a file Lars Hjemli
2007-06-11 19:12 ` [PATCH 2/5] git-submodule: remember to checkout after clone Lars Hjemli
2007-06-11 19:12 ` [PATCH 3/5] Rename sections from "module" to "submodule" in .gitmodules Lars Hjemli
2007-06-11 19:12 ` [PATCH 4/5] git-submodule: give submodules proper names Lars Hjemli
2007-06-11 19:12 ` [PATCH 5/5] Add gitmodules(5) Lars Hjemli
2007-06-11 22:59 ` Frank Lichtenheld
2007-06-12 7:05 ` Lars Hjemli
2007-06-12 8:04 ` Sven Verdoolaege
2007-06-12 8:27 ` Lars Hjemli
2007-06-12 9:45 ` Josef Weidendorfer
2007-06-12 10:23 ` Lars Hjemli
2007-06-12 12:05 ` Josef Weidendorfer
2007-06-12 9:49 ` Sven Verdoolaege
2007-06-12 10:28 ` Lars Hjemli
2007-06-12 10:34 ` Johannes Sixt
2007-06-12 10:48 ` Johannes Sixt
[not found] ` <8c5c35580706120352y24e53a10sf339147b22f1286e@mail.gmail.com>
2007-06-12 10:54 ` Lars Hjemli
2007-06-12 11:03 ` Johannes Sixt
2007-06-12 11:12 ` Lars Hjemli
2007-06-12 12:23 ` Josef Weidendorfer
2007-06-12 12:37 ` Lars Hjemli
2007-06-12 12:41 ` Johannes Sixt
2007-06-12 13:40 ` Josef Weidendorfer
2007-06-12 13:50 ` Josef Weidendorfer
2007-06-12 19:03 ` Junio C Hamano
2007-06-12 19:10 ` Sven Verdoolaege
2007-06-12 21:33 ` Josef Weidendorfer
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=op.ttqc4znc9pspc6@localhost \
--to=hjemli@gmail.com \
--cc=git@vger.kernel.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).