diff options
| author | Mike Frysinger <vapier@google.com> | 2020-02-09 02:27:54 -0500 |
|---|---|---|
| committer | David Pursehouse <dpursehouse@collab.net> | 2020-02-10 00:12:17 +0000 |
| commit | 09dd9bda38bd0bcf62ce882f2f80e6dcdcc91e64 (patch) | |
| tree | 8b9f38d5b9bc8615c5b473f9a93aa1b0b6c1caad /docs | |
| parent | f914edca5354141facc7e6c9f7facd77835ed766 (diff) | |
| download | git-repo-09dd9bda38bd0bcf62ce882f2f80e6dcdcc91e64.tar.gz git-repo-09dd9bda38bd0bcf62ce882f2f80e6dcdcc91e64.zip | |
docs: document internal manifests.git/config settings
Change-Id: I6b32d925756375a9335522ff33376cb5f7ed1157
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/254073
Tested-by: Mike Frysinger <vapier@google.com>
Reviewed-by: David Pursehouse <dpursehouse@collab.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internal-fs-layout.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/internal-fs-layout.md b/docs/internal-fs-layout.md index 231531cd4..9ca04148a 100644 --- a/docs/internal-fs-layout.md +++ b/docs/internal-fs-layout.md @@ -103,6 +103,29 @@ support, see the [manifest-format.md] file. * `subprojects/`: Like `projects/`, but for git submodules. * `subproject-objects/`: Like `project-objects/`, but for git submodules. +### Settings + +The `.repo/manifests.git/config` file is used to track settings for the entire +repo client checkout. +Most settings use the `[repo]` section to avoid conflicts with git. +User controlled settings are initialized when running `repo init`. + +| Setting | `repo init` Option | Use/Meaning | +|-------------------|---------------------------|-------------| +| manifest.groups | `--groups` & `--platform` | The manifest groups to sync | +| repo.archive | `--archive` | Use `git archive` for checkouts | +| repo.clonefilter | `--clone-filter` | Filter setting when using [partial git clones] | +| repo.depth | `--depth` | Create shallow checkouts when cloning | +| repo.dissociate | `--dissociate` | Dissociate from any reference/mirrors after initial clone | +| repo.mirror | `--mirror` | Checkout is a repo mirror | +| repo.partialclone | `--partial-clone` | Create [partial git clones] | +| repo.reference | `--reference` | Reference repo client checkout | +| repo.submodules | `--submodules` | Sync git submodules | +| user.email | `--config-name` | User's e-mail address; Copied into `.git/config` when checking out a new project | +| user.name | `--config-name` | User's name; Copied into `.git/config` when checking out a new project | + +[partial git clones]: https://git-scm.com/docs/gitrepository-layout#_code_partialclone_code + ## ~/ dotconfig layout Repo will create & maintain a few files in the user's home directory. |