diff options
| author | Mike Frysinger <vapier@google.com> | 2020-02-21 00:49:41 -0500 | 
|---|---|---|
| committer | David Pursehouse <dpursehouse@collab.net> | 2020-02-22 04:38:17 +0000 | 
| commit | a269b1cb9dc21dfd598bfea3766206b606ad4589 (patch) | |
| tree | 70d4344fcac2b422486046ed8394fa5c68d901c2 /docs/internal-fs-layout.md | |
| parent | 7951e143852bd861da21253275131d1fa79714d0 (diff) | |
| download | git-repo-a269b1cb9dc21dfd598bfea3766206b606ad4589.tar.gz | |
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.md | 13 | 
1 files changed, 10 insertions, 3 deletions
| diff --git a/docs/internal-fs-layout.md b/docs/internal-fs-layout.md index 0b6c4709..8050e4f0 100644 --- a/docs/internal-fs-layout.md +++ b/docs/internal-fs-layout.md | |||
| @@ -68,13 +68,20 @@ support, see the [manifest-format.md] file. | |||
| 68 | If you want to switch the tracking settings, re-run `repo init` with the | 68 | If you want to switch the tracking settings, re-run `repo init` with the | 
| 69 | new settings. | 69 | new settings. | 
| 70 | 70 | ||
| 71 | * `manifest.xml`: The manifest that repo uses. It is generated at `repo init` | ||
| 72 | and uses the `--manifest-name` to determine what manifest file to load next | ||
| 73 | out of `manifests/`. | ||
| 74 | |||
| 75 | Do not try to modify this to load other manifests as it will confuse repo. | ||
| 76 | If you want to switch manifest files, re-run `repo init` with the new | ||
| 77 | setting. | ||
| 78 | |||
| 79 | Older versions of repo managed this with symlinks. | ||
| 80 | |||
| 71 | * `manifest.xml -> manifests/<manifest-name>.xml`: A symlink to the manifest | 81 | * `manifest.xml -> manifests/<manifest-name>.xml`: A symlink to the manifest | 
| 72 | that the user wishes to sync. It is specified at `repo init` time via | 82 | that the user wishes to sync. It is specified at `repo init` time via | 
| 73 | `--manifest-name`. | 83 | `--manifest-name`. | 
| 74 | 84 | ||
| 75 | Do not try to repoint this symlink to other files as it will confuse repo. | ||
| 76 | If you want to switch manifest files, re-run `repo init` with the new | ||
| 77 | setting. | ||
| 78 | 85 | ||
| 79 | * `manifests.git/.repo_config.json`: JSON cache of the `manifests.git/config` | 86 | * `manifests.git/.repo_config.json`: JSON cache of the `manifests.git/config` | 
| 80 | file for repo to read/process quickly. | 87 | file for repo to read/process quickly. | 
