mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-10 06:26:13 +02:00
Code

Merge branch 'mk/doc-gitfile-more' into maint-2.43 

Doc update.

* mk/doc-gitfile-more:
  doc: make the gitfile syntax easier to discover
This commit is contained in:
Junio C Hamano 2024-02-08 16:22:06 -08:00
parent 67bb8ff5da e4299d26d4
commit 1dbc46997a
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/gitrepository-layout.txt
View File

@ -23,7 +23,9 @@ A Git repository comes in two different flavours:
*Note*: Also you can have a plain text file `.git` at the root of
your working tree, containing `gitdir: <path>` to point at the real
directory that has the repository. This mechanism is often used for
directory that has the repository.
This mechanism is called a 'gitfile' and is usually managed via the
`git submodule` and `git worktree` commands. It is often used for
a working tree of a submodule checkout, to allow you in the
containing superproject to `git checkout` a branch that does not
have the submodule. The `checkout` has to remove the entire

2
Documentation/glossary-content.txt
View File

@ -202,6 +202,8 @@ current branch integrates with) obviously do not work, as there is no
[[def_gitfile]]gitfile::
A plain file `.git` at the root of a working tree that
points at the directory that is the real repository.
For proper use see linkgit:git-worktree[1] or linkgit:git-submodule[1].
For syntax see linkgit:gitrepository-layout[5].
[[def_grafts]]grafts::
Grafts enable two otherwise different lines of development to be joined