gitmodules man page on OpenBSD

Man page or keyword search:  
man Server   11362 pages
apropos Keyword Search (all sections)
Output format
OpenBSD logo
[printable version]



GITMODULES(5)					    GITMODULES(5)

NAME
       gitmodules - defining submodule properties

SYNOPSIS
       $GIT_WORK_DIR/.gitmodules

DESCRIPTION
       The .gitmodules file, located in the top-level directory of a git work-
       ing tree, is a text file with a syntax  matching	 the  requirements  of
       git-config(1).

       The  file  contains  one	 subsection  per submodule, and the subsection
       value is the name of the submodule. Each submodule  section  also  con-
       tains 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. This may be either an absolute URL ready to be passed to
	      git-clone(1) or (if it begins with ./ or ../) a  location	 rela-
	      tive to the superproject’s origin repository.

       submodule.<name>.update
	      Defines  what  to do when the submodule is updated by the super-
	      project. If checkout (the default), the new commit specified  in
	      the  superproject	 will  be  checked  out	 in the submodule on a
	      detached HEAD. If rebase, the current branch  of	the  submodule
	      will  be	rebased onto the commit specified in the superproject.
	      If merge, the commit  specified  in  the	superproject  will  be
	      merged  into  the	 current  branch in the submodule. This config
	      option is overridden  if	git  submodule	update	is  given  the
	      --merge or --rebase options.

       submodule.<name>.ignore
	      Defines  under what circumstances "git status" and the diff fam-
	      ily show a submodule as modified. When set  to  "all",  it  will
	      never be considered modified, "dirty" will ignore all changes to
	      the submodules work tree and takes only differences between  the
	      HEAD  of	the submodule and the commit recorded in the superpro-
	      ject into account. "untracked" will additionally let  submodules
	      with  modified  tracked  files in their work tree show up. Using
	      "none" (the default when this option is not set) also shows sub-
	      modules that have untracked files in their work tree as changed.

								1

GITMODULES(5)					    GITMODULES(5)

	      If this option is	 also  present	in  the	 submodules  entry  in
	      .git/config of the superproject, the setting there will override
	      the one found in .gitmodules. Both settings can be overridden on
	      the command line by using the "--ignore-submodule" option.

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 sub-
       modules.

SEE ALSO
       git-submodule(1) git-config(1)

DOCUMENTATION
       Documentation	   by	    Lars       Hjemli	    <hjemli@gmail.com:
       mailto:hjemli@gmail.com>

GIT
       Part of the git(1) suite

								2

[top]

List of man pages available for OpenBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net