summaryrefslogtreecommitdiffstats
path: root/docs/internal-fs-layout.md
diff options
context:
space:
mode:
authorMike Frysinger <vapier@google.com>2020-02-09 02:27:54 -0500
committerDavid Pursehouse <dpursehouse@collab.net>2020-02-10 00:12:17 +0000
commit09dd9bda38bd0bcf62ce882f2f80e6dcdcc91e64 (patch)
tree8b9f38d5b9bc8615c5b473f9a93aa1b0b6c1caad /docs/internal-fs-layout.md
parentf914edca5354141facc7e6c9f7facd77835ed766 (diff)
downloadgit-repo-09dd9bda38bd0bcf62ce882f2f80e6dcdcc91e64.tar.gz
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/internal-fs-layout.md')
-rw-r--r--docs/internal-fs-layout.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/internal-fs-layout.md b/docs/internal-fs-layout.md
index 231531cd..9ca04148 100644
--- a/docs/internal-fs-layout.md
+++ b/docs/internal-fs-layout.md
@@ -103,6 +103,29 @@ support, see the [manifest-format.md] file.
103* `subprojects/`: Like `projects/`, but for git submodules. 103* `subprojects/`: Like `projects/`, but for git submodules.
104* `subproject-objects/`: Like `project-objects/`, but for git submodules. 104* `subproject-objects/`: Like `project-objects/`, but for git submodules.
105 105
106### Settings
107
108The `.repo/manifests.git/config` file is used to track settings for the entire
109repo client checkout.
110Most settings use the `[repo]` section to avoid conflicts with git.
111User controlled settings are initialized when running `repo init`.
112
113| Setting | `repo init` Option | Use/Meaning |
114|-------------------|---------------------------|-------------|
115| manifest.groups | `--groups` & `--platform` | The manifest groups to sync |
116| repo.archive | `--archive` | Use `git archive` for checkouts |
117| repo.clonefilter | `--clone-filter` | Filter setting when using [partial git clones] |
118| repo.depth | `--depth` | Create shallow checkouts when cloning |
119| repo.dissociate | `--dissociate` | Dissociate from any reference/mirrors after initial clone |
120| repo.mirror | `--mirror` | Checkout is a repo mirror |
121| repo.partialclone | `--partial-clone` | Create [partial git clones] |
122| repo.reference | `--reference` | Reference repo client checkout |
123| repo.submodules | `--submodules` | Sync git submodules |
124| user.email | `--config-name` | User's e-mail address; Copied into `.git/config` when checking out a new project |
125| user.name | `--config-name` | User's name; Copied into `.git/config` when checking out a new project |
126
127[partial git clones]: https://git-scm.com/docs/gitrepository-layout#_code_partialclone_code
128
106## ~/ dotconfig layout 129## ~/ dotconfig layout
107 130
108Repo will create & maintain a few files in the user's home directory. 131Repo will create & maintain a few files in the user's home directory.