summaryrefslogtreecommitdiff
path: root/docs/internal-fs-layout.md
diff options
context:
space:
mode:
authorMike Frysinger <vapier@google.com>2020-02-21 00:49:41 -0500
committerDavid Pursehouse <dpursehouse@collab.net>2020-02-22 04:38:17 +0000
commita269b1cb9dc21dfd598bfea3766206b606ad4589 (patch)
tree70d4344fcac2b422486046ed8394fa5c68d901c2 /docs/internal-fs-layout.md
parent7951e143852bd861da21253275131d1fa79714d0 (diff)
downloadgit-repo-a269b1cb9dc21dfd598bfea3766206b606ad4589.tar.gz
git-repo-a269b1cb9dc21dfd598bfea3766206b606ad4589.zip
manifest_xml: change .repo/manifest.xml to a plain file
Changing this to a file instead of using a symlink serves two purposes: * We can insert some comments & doc links to help users learn what this is for, discover relevant documentation, and to discourage them from modifying things. * Windows requires Administrator access to use symlinks. With this last change, Windows users can get repo client checkouts with the new --worktree option and not need symlinks anywhere at all. Which means they no longer need to be an Administrator in order to `repo sync`. Change-Id: I9bc46824fd8d4b0f446ba84bd764994ca1e597e2 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/256313 Tested-by: Mike Frysinger <vapier@google.com> Reviewed-by: David Pursehouse <dpursehouse@collab.net>
Diffstat (limited to 'docs/internal-fs-layout.md')
-rw-r--r--docs/internal-fs-layout.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/internal-fs-layout.md b/docs/internal-fs-layout.md
index 0b6c4709c..8050e4f02 100644
--- a/docs/internal-fs-layout.md
+++ b/docs/internal-fs-layout.md
@@ -68,13 +68,20 @@ support, see the [manifest-format.md] file.
If you want to switch the tracking settings, re-run `repo init` with the
new settings.
+* `manifest.xml`: The manifest that repo uses. It is generated at `repo init`
+ and uses the `--manifest-name` to determine what manifest file to load next
+ out of `manifests/`.
+
+ Do not try to modify this to load other manifests as it will confuse repo.
+ If you want to switch manifest files, re-run `repo init` with the new
+ setting.
+
+ Older versions of repo managed this with symlinks.
+
* `manifest.xml -> manifests/<manifest-name>.xml`: A symlink to the manifest
that the user wishes to sync. It is specified at `repo init` time via
`--manifest-name`.
- Do not try to repoint this symlink to other files as it will confuse repo.
- If you want to switch manifest files, re-run `repo init` with the new
- setting.
* `manifests.git/.repo_config.json`: JSON cache of the `manifests.git/config`
file for repo to read/process quickly.