THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

63 lines
1.4 KiB

  1. gitmodules(5)
  2. =============
  3. NAME
  4. ----
  5. gitmodules - defining submodule properties
  6. SYNOPSIS
  7. --------
  8. $GIT_WORK_DIR/.gitmodules
  9. DESCRIPTION
  10. -----------
  11. The `.gitmodules` file, located in the top-level directory of a git
  12. working tree, is a text file with a syntax matching the requirements
  13. of linkgit:git-config[1].
  14. The file contains one subsection per submodule, and the subsection value
  15. is the name of the submodule. Each submodule section also contains the
  16. following required keys:
  17. submodule.<name>.path::
  18. Defines the path, relative to the top-level directory of the git
  19. working tree, where the submodule is expected to be checked out.
  20. The path name must not end with a `/`. All submodule paths must
  21. be unique within the .gitmodules file.
  22. submodule.<name>.url::
  23. Defines an url from where the submodule repository can be cloned.
  24. EXAMPLES
  25. --------
  26. Consider the following .gitmodules file:
  27. [submodule "libfoo"]
  28. path = include/foo
  29. url = git://foo.com/git/lib.git
  30. [submodule "libbar"]
  31. path = include/bar
  32. url = git://bar.com/git/lib.git
  33. This defines two submodules, `libfoo` and `libbar`. These are expected to
  34. be checked out in the paths 'include/foo' and 'include/bar', and for both
  35. submodules an url is specified which can be used for cloning the submodules.
  36. SEE ALSO
  37. --------
  38. linkgit:git-submodule[1] linkgit:git-config[1]
  39. DOCUMENTATION
  40. -------------
  41. Documentation by Lars Hjemli <hjemli@gmail.com>
  42. GIT
  43. ---
  44. Part of the linkgit:git[1] suite