git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Marcel Krause <mk+copyleft@pimpmybyte.de>
To: git mailing list <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>,
	Marcel Krause <mk+copyleft@pimpmybyte.de>
Subject: [PATCH] doc: make the gitfile syntax easier to discover
Date: Tue, 28 Nov 2023 07:55:58 +0100	[thread overview]
Message-ID: <20231128065558.1061206-1-mk+copyleft@pimpmybyte.de> (raw)
In-Reply-To: <182d290a-86e5-b361-87a1-6860641fc726@pimpmybyte.de>

Signed-off-by: Marcel Krause <mk+copyleft@pimpmybyte.de>
---
 Documentation/gitrepository-layout.txt | 4 +++-
 Documentation/glossary-content.txt     | 2 ++
 2 files changed, 5 insertions(+), 1 deletion(-)

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 5a537268e2..3f912e7bb2 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -184,6 +184,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 enables two otherwise different lines of development to be joined
-- 
2.25.1


  parent reply	other threads:[~2023-11-28  6:59 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-24 19:47 [PATCH] doc: make the gitfile syntax easier to discover Marcel Krause
2023-11-26  3:04 ` Junio C Hamano
2023-11-28  1:51   ` Marcel Krause
2023-11-28  5:55     ` Marcel Krause
2023-11-28  6:48       ` Marcel Krause
2023-11-28  6:55       ` Marcel Krause [this message]
2023-12-03 13:15         ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231128065558.1061206-1-mk+copyleft@pimpmybyte.de \
    --to=mk+copyleft@pimpmybyte.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).