doc/source/en/TortoiseGit/git_doc/gitmodules.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="gitmodules(5)">\r
   5 <articleinfo>\r
   6     <title>gitmodules(5)</title>\r
   7         <indexterm>\r
   8                 <primary>gitmodules(5)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>gitmodules - defining submodule properties</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <simpara>$GIT_WORK_DIR/.gitmodules</simpara>\r
  18 </simplesect>\r
  19 <simplesect id="_description">\r
  20 <title>DESCRIPTION</title>\r
  21 <simpara>The <literal>.gitmodules</literal> file, located in the top-level directory of a git\r
  22 working tree, is a text file with a syntax matching the requirements\r
  23 of <xref linkend="git-config(1)"/>.</simpara>\r
  24 <simpara>The file contains one subsection per submodule, and the subsection value\r
  25 is the name of the submodule. Each submodule section also contains the\r
  26 following required keys:</simpara>\r
  27 <variablelist>\r
  28 <varlistentry>\r
  29 <term>\r
  30 submodule.&lt;name&gt;.path\r
  31 </term>\r
  32 <listitem>\r
  33 <simpara>\r
  34         Defines the path, relative to the top-level directory of the git\r
  35         working tree, where the submodule is expected to be checked out.\r
  36         The path name must not end with a <literal>/</literal>. All submodule paths must\r
  37         be unique within the .gitmodules file.\r
  38 </simpara>\r
  39 </listitem>\r
  40 </varlistentry>\r
  41 <varlistentry>\r
  42 <term>\r
  43 submodule.&lt;name&gt;.url\r
  44 </term>\r
  45 <listitem>\r
  46 <simpara>\r
  47         Defines an url from where the submodule repository can be cloned.\r
  48 </simpara>\r
  49 </listitem>\r
  50 </varlistentry>\r
  51 </variablelist>\r
  52 </simplesect>\r
  53 <simplesect id="_examples">\r
  54 <title>EXAMPLES</title>\r
  55 <simpara>Consider the following .gitmodules file:</simpara>\r
  56 <literallayout class="monospaced">[submodule "libfoo"]\r
  57         path = include/foo\r
  58         url = git://foo.com/git/lib.git</literallayout>\r
  59 <literallayout class="monospaced">[submodule "libbar"]\r
  60         path = include/bar\r
  61         url = git://bar.com/git/lib.git</literallayout>\r
  62 <simpara>This defines two submodules, <literal>libfoo</literal> and <literal>libbar</literal>. These are expected to\r
  63 be checked out in the paths <emphasis>include/foo</emphasis> and <emphasis>include/bar</emphasis>, and for both\r
  64 submodules an url is specified which can be used for cloning the submodules.</simpara>\r
  65 </simplesect>\r
  66 <simplesect id="_see_also">\r
  67 <title>SEE ALSO</title>\r
  68 <simpara><xref linkend="git-submodule(1)"/> <xref linkend="git-config(1)"/></simpara>\r
  69 </simplesect>\r
  70 <simplesect id="_documentation">\r
  71 <title>DOCUMENTATION</title>\r
  72 <simpara>Documentation by Lars Hjemli &lt;<ulink url="mailto:hjemli@gmail.com">hjemli@gmail.com</ulink>&gt;</simpara>\r
  73 </simplesect>\r
  74 <simplesect id="_git">\r
  75 <title>GIT</title>\r
  76 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
  77 </simplesect>\r
  78 </article>\r