diff options
Diffstat (limited to 'man/repo-gitc-init.1')
| -rw-r--r-- | man/repo-gitc-init.1 | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/man/repo-gitc-init.1 b/man/repo-gitc-init.1 new file mode 100644 index 00000000..9b61866e --- /dev/null +++ b/man/repo-gitc-init.1 | |||
| @@ -0,0 +1,150 @@ | |||
| 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man. | ||
| 2 | .TH REPO "1" "September 2021" "repo gitc-init" "Repo Manual" | ||
| 3 | .SH NAME | ||
| 4 | repo \- repo gitc-init - manual page for repo gitc-init | ||
| 5 | .SH SYNOPSIS | ||
| 6 | .B repo | ||
| 7 | \fI\,gitc-init \/\fR[\fI\,options\/\fR] [\fI\,client name\/\fR] | ||
| 8 | .SH DESCRIPTION | ||
| 9 | Summary | ||
| 10 | .PP | ||
| 11 | Initialize a GITC Client. | ||
| 12 | .SH OPTIONS | ||
| 13 | .TP | ||
| 14 | \fB\-h\fR, \fB\-\-help\fR | ||
| 15 | show this help message and exit | ||
| 16 | .SS Logging options: | ||
| 17 | .TP | ||
| 18 | \fB\-v\fR, \fB\-\-verbose\fR | ||
| 19 | show all output | ||
| 20 | .TP | ||
| 21 | \fB\-q\fR, \fB\-\-quiet\fR | ||
| 22 | only show errors | ||
| 23 | .SS Manifest options: | ||
| 24 | .TP | ||
| 25 | \fB\-u\fR URL, \fB\-\-manifest\-url\fR=\fI\,URL\/\fR | ||
| 26 | manifest repository location | ||
| 27 | .TP | ||
| 28 | \fB\-b\fR REVISION, \fB\-\-manifest\-branch\fR=\fI\,REVISION\/\fR | ||
| 29 | manifest branch or revision (use HEAD for default) | ||
| 30 | .TP | ||
| 31 | \fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml | ||
| 32 | initial manifest file | ||
| 33 | .TP | ||
| 34 | \fB\-\-standalone\-manifest\fR | ||
| 35 | download the manifest as a static file rather then | ||
| 36 | create a git checkout of the manifest repo | ||
| 37 | .TP | ||
| 38 | \fB\-g\fR GROUP, \fB\-\-groups\fR=\fI\,GROUP\/\fR | ||
| 39 | restrict manifest projects to ones with specified | ||
| 40 | group(s) [default|all|G1,G2,G3|G4,\-G5,\-G6] | ||
| 41 | .TP | ||
| 42 | \fB\-p\fR PLATFORM, \fB\-\-platform\fR=\fI\,PLATFORM\/\fR | ||
| 43 | restrict manifest projects to ones with a specified | ||
| 44 | platform group [auto|all|none|linux|darwin|...] | ||
| 45 | .TP | ||
| 46 | \fB\-\-submodules\fR | ||
| 47 | sync any submodules associated with the manifest repo | ||
| 48 | .SS Manifest (only) checkout options: | ||
| 49 | .TP | ||
| 50 | \fB\-\-current\-branch\fR | ||
| 51 | fetch only current manifest branch from server | ||
| 52 | .TP | ||
| 53 | \fB\-\-no\-current\-branch\fR | ||
| 54 | fetch all manifest branches from server | ||
| 55 | .TP | ||
| 56 | \fB\-\-tags\fR | ||
| 57 | fetch tags in the manifest | ||
| 58 | .TP | ||
| 59 | \fB\-\-no\-tags\fR | ||
| 60 | don't fetch tags in the manifest | ||
| 61 | .SS Checkout modes: | ||
| 62 | .TP | ||
| 63 | \fB\-\-mirror\fR | ||
| 64 | create a replica of the remote repositories rather | ||
| 65 | than a client working directory | ||
| 66 | .TP | ||
| 67 | \fB\-\-archive\fR | ||
| 68 | checkout an archive instead of a git repository for | ||
| 69 | each project. See git archive. | ||
| 70 | .TP | ||
| 71 | \fB\-\-worktree\fR | ||
| 72 | use git\-worktree to manage projects | ||
| 73 | .SS Project checkout optimizations: | ||
| 74 | .TP | ||
| 75 | \fB\-\-reference\fR=\fI\,DIR\/\fR | ||
| 76 | location of mirror directory | ||
| 77 | .TP | ||
| 78 | \fB\-\-dissociate\fR | ||
| 79 | dissociate from reference mirrors after clone | ||
| 80 | .TP | ||
| 81 | \fB\-\-depth\fR=\fI\,DEPTH\/\fR | ||
| 82 | create a shallow clone with given depth; see git clone | ||
| 83 | .TP | ||
| 84 | \fB\-\-partial\-clone\fR | ||
| 85 | perform partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) | ||
| 86 | .TP | ||
| 87 | \fB\-\-no\-partial\-clone\fR | ||
| 88 | disable use of partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) | ||
| 89 | .TP | ||
| 90 | \fB\-\-partial\-clone\-exclude\fR=\fI\,PARTIAL_CLONE_EXCLUDE\/\fR | ||
| 91 | exclude the specified projects (a comma\-delimited | ||
| 92 | project names) from partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) | ||
| 93 | .TP | ||
| 94 | \fB\-\-clone\-filter\fR=\fI\,CLONE_FILTER\/\fR | ||
| 95 | filter for use with \fB\-\-partial\-clone\fR [default: | ||
| 96 | blob:none] | ||
| 97 | .TP | ||
| 98 | \fB\-\-use\-superproject\fR | ||
| 99 | use the manifest superproject to sync projects | ||
| 100 | .TP | ||
| 101 | \fB\-\-no\-use\-superproject\fR | ||
| 102 | disable use of manifest superprojects | ||
| 103 | .TP | ||
| 104 | \fB\-\-clone\-bundle\fR | ||
| 105 | enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if | ||
| 106 | not \fB\-\-partial\-clone\fR) | ||
| 107 | .TP | ||
| 108 | \fB\-\-no\-clone\-bundle\fR | ||
| 109 | disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if | ||
| 110 | \fB\-\-partial\-clone\fR) | ||
| 111 | .SS repo Version options: | ||
| 112 | .TP | ||
| 113 | \fB\-\-repo\-url\fR=\fI\,URL\/\fR | ||
| 114 | repo repository location ($REPO_URL) | ||
| 115 | .TP | ||
| 116 | \fB\-\-repo\-rev\fR=\fI\,REV\/\fR | ||
| 117 | repo branch or revision ($REPO_REV) | ||
| 118 | .TP | ||
| 119 | \fB\-\-no\-repo\-verify\fR | ||
| 120 | do not verify repo source code | ||
| 121 | .SS Other options: | ||
| 122 | .TP | ||
| 123 | \fB\-\-config\-name\fR | ||
| 124 | Always prompt for name/e\-mail | ||
| 125 | .SS GITC options: | ||
| 126 | .TP | ||
| 127 | \fB\-f\fR MANIFEST_FILE, \fB\-\-manifest\-file\fR=\fI\,MANIFEST_FILE\/\fR | ||
| 128 | Optional manifest file to use for this GITC client. | ||
| 129 | .TP | ||
| 130 | \fB\-c\fR GITC_CLIENT, \fB\-\-gitc\-client\fR=\fI\,GITC_CLIENT\/\fR | ||
| 131 | Name of the gitc_client instance to create or modify. | ||
| 132 | .PP | ||
| 133 | Run `repo help gitc\-init` to view the detailed manual. | ||
| 134 | .SH DETAILS | ||
| 135 | .PP | ||
| 136 | The 'repo gitc\-init' command is ran to initialize a new GITC client for use with | ||
| 137 | the GITC file system. | ||
| 138 | .PP | ||
| 139 | This command will setup the client directory, initialize repo, just like repo | ||
| 140 | init does, and then downloads the manifest collection and installs it in the | ||
| 141 | \&.repo/directory of the GITC client. | ||
| 142 | .PP | ||
| 143 | Once this is done, a GITC manifest is generated by pulling the HEAD SHA for each | ||
| 144 | project and generates the properly formatted XML file and installs it as | ||
| 145 | \&.manifest in the GITC client directory. | ||
| 146 | .PP | ||
| 147 | The \fB\-c\fR argument is required to specify the GITC client name. | ||
| 148 | .PP | ||
| 149 | The optional \fB\-f\fR argument can be used to specify the manifest file to use for | ||
| 150 | this GITC client. | ||
