{"thread":{"id":"8551","subject":"[PATCH 5/5] Add gitmodules(5)","startedAt":"2007-06-11T00:04:01Z","lastAt":"2007-06-11T00:04:01Z","messageCount":1,"participants":["Lars Hjemli"],"isPatch":true,"patchVersion":1,"patchTotal":5},"messages":[{"id":"44673","messageId":"op.ttqc4znc9pspc6@localhost","threadId":"8551","inReplyTo":null,"subject":"[PATCH 5/5] Add gitmodules(5)","fromName":"Lars Hjemli","fromEmail":"hjemli@gmail.com","sentAt":"2007-06-11T00:04:01Z","receivedAt":"2007-06-11T00:04:01Z","isPatch":true,"sender":{"key":"hjemli@gmail.com","avatar":null},"body":"This adds documentation for the .gitmodules file.\n\nSigned-off-by: Lars Hjemli <hjemli@gmail.com>\n---\n  Documentation/Makefile       |    2 +-\n  Documentation/gitmodules.txt |   62 ++++++++++++++++++++++++++++++++++++++++++\n  2 files changed, 63 insertions(+), 1 deletions(-)\n  create mode 100644 Documentation/gitmodules.txt\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 9cef480..2ad18e0 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -2,7 +2,7 @@ MAN1_TXT= \\\n  \t$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \\\n  \t\t$(wildcard git-*.txt)) \\\n  \tgitk.txt\n-MAN5_TXT=gitattributes.txt gitignore.txt\n+MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt\n  MAN7_TXT=git.txt\n\n  DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))\ndiff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\nnew file mode 100644\nindex 0000000..6c7d9bf\n--- /dev/null\n+++ b/Documentation/gitmodules.txt\n@@ -0,0 +1,62 @@\n+gitmodules(5)\n+=============\n+\n+NAME\n+----\n+gitmodules - defining submodule properties\n+\n+SYNOPSIS\n+--------\n+.gitmodules\n+\n+\n+DESCRIPTION\n+-----------\n+\n+The `.gitmodules` file, located in the top-level directory of a git\n+working tree, is a text file with a syntax matching the requirements\n+of gitlink:git-config[1].\n+\n+The file contains one subsection per submodule, and the subsection value\n+is the name of the submodule. Each submodule section also contains the\n+following required keys:\n+\n+submodule.<name>.path::\n+\tDefines the path, relative to the top-level directory of the git\n+\tworking tree, where the submodule is expected to be checked out.\n+\tThe path name must not end with a `/`. All submodule paths must\n+\tbe unique within the .gitmodules file.\n+\n+submodule.<name>.url::\n+\tDefines an url from where the submodule repository can be cloned.\n+\n+\n+EXAMPLES\n+--------\n+\n+Consider the following .gitmodules file:\n+\n+\t[submodule 'libfoo']\n+\t\tpath = include/foo\n+\t\turl = git://foo.com/git/lib.git\n+\n+\t[submodule 'libbar']\n+\t\tpath = include/bar\n+\t\turl = git://bar.com/git/lib.git\n+\n+\n+This defines two submodules, `libfoo` and `libbar`. These are expected to\n+be checked out in the paths 'include/foo' and 'include/bar', and for both\n+submodules an url is specified which can be used for cloning the submodules.\n+\n+SEE ALSO\n+--------\n+gitlink:git-submodule[1] gitlink:git-config[1]\n+\n+DOCUMENTATION\n+-------------\n+Documentation by Lars Hjemli <hjemli@gmail.com>\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\n-- \n1.5.2.1.914.gbd3a7\n"}]}