diff options
| author | Junio C Hamano <gitster@pobox.com> | 2023-12-20 10:14:53 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-12-20 10:14:53 -0800 |
| commit | 2d09302a01ecf53df3aa9997f7353fb4e845922c (patch) | |
| tree | 6de4138be2cbd2c489d740e69835951bf8a092b1 | |
| parent | a21a9296439cbbf548b87d820cd9de9ff81fea22 (diff) | |
| parent | e4299d26d4bee3120429d49baa320a406fbfe07c (diff) | |
| download | git-2d09302a01ecf53df3aa9997f7353fb4e845922c.tar.gz | |
Merge branch 'mk/doc-gitfile-more'
Doc update.
* mk/doc-gitfile-more:
doc: make the gitfile syntax easier to discover
| -rw-r--r-- | Documentation/gitrepository-layout.txt | 4 | ||||
| -rw-r--r-- | Documentation/glossary-content.txt | 2 |
2 files changed, 5 insertions, 1 deletions
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index 1a2ef4c150..949cd8a31e 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -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 diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 59d8ab8572..fbbb3f2de3 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -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 |