From cbd78a91943d1099dad8e285c5adfcf3a269b7ad Mon Sep 17 00:00:00 2001 From: Mike Frysinger Date: Thu, 11 Apr 2024 08:32:40 -0400 Subject: [PATCH] man: regenerate man pages Change-Id: I8d9dcb37f315d4208b7c8005206ae939dad79a3e Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/419197 Tested-by: Mike Frysinger Commit-Queue: Mike Frysinger Reviewed-by: Josip Sokcevic --- man/repo-gitc-delete.1 | 44 ----------- man/repo-gitc-init.1 | 175 ----------------------------------------- man/repo-manifest.1 | 30 +++++-- man/repo-smartsync.1 | 7 +- man/repo-sync.1 | 12 ++- man/repo-upload.1 | 11 ++- man/repo.1 | 8 +- 7 files changed, 51 insertions(+), 236 deletions(-) delete mode 100644 man/repo-gitc-delete.1 delete mode 100644 man/repo-gitc-init.1 diff --git a/man/repo-gitc-delete.1 b/man/repo-gitc-delete.1 deleted file mode 100644 index 6158bd3b..00000000 --- a/man/repo-gitc-delete.1 +++ /dev/null @@ -1,44 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "July 2022" "repo gitc-delete" "Repo Manual" -.SH NAME -repo \- repo gitc-delete - manual page for repo gitc-delete -.SH SYNOPSIS -.B repo -\fI\,gitc-delete\/\fR -.SH DESCRIPTION -Summary -.PP -Delete a GITC Client. -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-f\fR, \fB\-\-force\fR -force the deletion (no prompt) -.SS Logging options: -.TP -\fB\-v\fR, \fB\-\-verbose\fR -show all output -.TP -\fB\-q\fR, \fB\-\-quiet\fR -only show errors -.SS Multi\-manifest options: -.TP -\fB\-\-outer\-manifest\fR -operate starting at the outermost manifest -.TP -\fB\-\-no\-outer\-manifest\fR -do not operate on outer manifests -.TP -\fB\-\-this\-manifest\-only\fR -only operate on this (sub)manifest -.TP -\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR -operate on this manifest and its submanifests -.PP -Run `repo help gitc\-delete` to view the detailed manual. -.SH DETAILS -.PP -This subcommand deletes the current GITC client, deleting the GITC manifest and -all locally downloaded sources. diff --git a/man/repo-gitc-init.1 b/man/repo-gitc-init.1 deleted file mode 100644 index 02581c69..00000000 --- a/man/repo-gitc-init.1 +++ /dev/null @@ -1,175 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "October 2022" "repo gitc-init" "Repo Manual" -.SH NAME -repo \- repo gitc-init - manual page for repo gitc-init -.SH SYNOPSIS -.B repo -\fI\,gitc-init \/\fR[\fI\,options\/\fR] [\fI\,client name\/\fR] -.SH DESCRIPTION -Summary -.PP -Initialize a GITC Client. -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.SS Logging options: -.TP -\fB\-v\fR, \fB\-\-verbose\fR -show all output -.TP -\fB\-q\fR, \fB\-\-quiet\fR -only show errors -.SS Manifest options: -.TP -\fB\-u\fR URL, \fB\-\-manifest\-url\fR=\fI\,URL\/\fR -manifest repository location -.TP -\fB\-b\fR REVISION, \fB\-\-manifest\-branch\fR=\fI\,REVISION\/\fR -manifest branch or revision (use HEAD for default) -.TP -\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml -initial manifest file -.TP -\fB\-g\fR GROUP, \fB\-\-groups\fR=\fI\,GROUP\/\fR -restrict manifest projects to ones with specified -group(s) [default|all|G1,G2,G3|G4,\-G5,\-G6] -.TP -\fB\-p\fR PLATFORM, \fB\-\-platform\fR=\fI\,PLATFORM\/\fR -restrict manifest projects to ones with a specified -platform group [auto|all|none|linux|darwin|...] -.TP -\fB\-\-submodules\fR -sync any submodules associated with the manifest repo -.TP -\fB\-\-standalone\-manifest\fR -download the manifest as a static file rather then -create a git checkout of the manifest repo -.TP -\fB\-\-manifest\-depth\fR=\fI\,DEPTH\/\fR -create a shallow clone of the manifest repo with given -depth (0 for full clone); see git clone (default: 0) -.SS Manifest (only) checkout options: -.TP -\fB\-\-current\-branch\fR -fetch only current manifest branch from server -(default) -.TP -\fB\-\-no\-current\-branch\fR -fetch all manifest branches from server -.TP -\fB\-\-tags\fR -fetch tags in the manifest -.TP -\fB\-\-no\-tags\fR -don't fetch tags in the manifest -.SS Checkout modes: -.TP -\fB\-\-mirror\fR -create a replica of the remote repositories rather -than a client working directory -.TP -\fB\-\-archive\fR -checkout an archive instead of a git repository for -each project. See git archive. -.TP -\fB\-\-worktree\fR -use git\-worktree to manage projects -.SS Project checkout optimizations: -.TP -\fB\-\-reference\fR=\fI\,DIR\/\fR -location of mirror directory -.TP -\fB\-\-dissociate\fR -dissociate from reference mirrors after clone -.TP -\fB\-\-depth\fR=\fI\,DEPTH\/\fR -create a shallow clone with given depth; see git clone -.TP -\fB\-\-partial\-clone\fR -perform partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) -.TP -\fB\-\-no\-partial\-clone\fR -disable use of partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) -.TP -\fB\-\-partial\-clone\-exclude\fR=\fI\,PARTIAL_CLONE_EXCLUDE\/\fR -exclude the specified projects (a comma\-delimited -project names) from partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) -.TP -\fB\-\-clone\-filter\fR=\fI\,CLONE_FILTER\/\fR -filter for use with \fB\-\-partial\-clone\fR [default: -blob:none] -.TP -\fB\-\-use\-superproject\fR -use the manifest superproject to sync projects; -implies \fB\-c\fR -.TP -\fB\-\-no\-use\-superproject\fR -disable use of manifest superprojects -.TP -\fB\-\-clone\-bundle\fR -enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if -not \fB\-\-partial\-clone\fR) -.TP -\fB\-\-no\-clone\-bundle\fR -disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if -\fB\-\-partial\-clone\fR) -.TP -\fB\-\-git\-lfs\fR -enable Git LFS support -.TP -\fB\-\-no\-git\-lfs\fR -disable Git LFS support -.SS repo Version options: -.TP -\fB\-\-repo\-url\fR=\fI\,URL\/\fR -repo repository location ($REPO_URL) -.TP -\fB\-\-repo\-rev\fR=\fI\,REV\/\fR -repo branch or revision ($REPO_REV) -.TP -\fB\-\-no\-repo\-verify\fR -do not verify repo source code -.SS Other options: -.TP -\fB\-\-config\-name\fR -Always prompt for name/e\-mail -.SS GITC options: -.TP -\fB\-f\fR MANIFEST_FILE, \fB\-\-manifest\-file\fR=\fI\,MANIFEST_FILE\/\fR -Optional manifest file to use for this GITC client. -.TP -\fB\-c\fR GITC_CLIENT, \fB\-\-gitc\-client\fR=\fI\,GITC_CLIENT\/\fR -Name of the gitc_client instance to create or modify. -.SS Multi\-manifest: -.TP -\fB\-\-outer\-manifest\fR -operate starting at the outermost manifest -.TP -\fB\-\-no\-outer\-manifest\fR -do not operate on outer manifests -.TP -\fB\-\-this\-manifest\-only\fR -only operate on this (sub)manifest -.TP -\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR -operate on this manifest and its submanifests -.PP -Run `repo help gitc\-init` to view the detailed manual. -.SH DETAILS -.PP -The 'repo gitc\-init' command is ran to initialize a new GITC client for use with -the GITC file system. -.PP -This command will setup the client directory, initialize repo, just like repo -init does, and then downloads the manifest collection and installs it in the -\&.repo/directory of the GITC client. -.PP -Once this is done, a GITC manifest is generated by pulling the HEAD SHA for each -project and generates the properly formatted XML file and installs it as -\&.manifest in the GITC client directory. -.PP -The \fB\-c\fR argument is required to specify the GITC client name. -.PP -The optional \fB\-f\fR argument can be used to specify the manifest file to use for -this GITC client. diff --git a/man/repo-manifest.1 b/man/repo-manifest.1 index e49836ca..10ec2e75 100644 --- a/man/repo-manifest.1 +++ b/man/repo-manifest.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "October 2022" "repo manifest" "Repo Manual" +.TH REPO "1" "April 2024" "repo manifest" "Repo Manual" .SH NAME repo \- repo manifest - manual page for repo manifest .SH SYNOPSIS @@ -194,8 +194,9 @@ CDATA #IMPLIED> .IP - - + + + .IP @@ -210,8 +211,9 @@ CDATA #IMPLIED> .IP - - + + + .PP ]> ``` @@ -533,13 +535,24 @@ the repo client. .PP Element remove\-project .PP -Deletes the named project from the internal manifest table, possibly allowing a +Deletes a project from the internal manifest table, possibly allowing a subsequent project element in the same manifest file to replace the project with a different source. .PP This element is mostly useful in a local manifest file, where the user can remove a project, and possibly replace it with their own definition. .PP +The project `name` or project `path` can be used to specify the remove target +meaning one of them is required. If only name is specified, all projects with +that name are removed. +.PP +If both name and path are specified, only projects with the same name and path +are removed, meaning projects with the same name but in other locations are +kept. +.PP +If only path is specified, a matching project is removed regardless of its name. +Logic otherwise behaves like both are specified. +.PP Attribute `optional`: Set to true to ignore remove\-project elements with no matching `project` element. .PP @@ -608,7 +621,10 @@ included manifest belong. This appends and recurses, meaning all projects in included manifests carry all parent include groups. Same syntax as the corresponding element of `project`. .PP -Local Manifests +Attribute `revision`: Name of a Git branch (e.g. `main` or `refs/heads/main`) +default to which all projects in the included manifest belong. +.PP +Local Manifests .PP Additional remotes and projects may be added through local manifest files stored in `$TOP_DIR/.repo/local_manifests/*.xml`. diff --git a/man/repo-smartsync.1 b/man/repo-smartsync.1 index c1abbb38..1e979102 100644 --- a/man/repo-smartsync.1 +++ b/man/repo-smartsync.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "November 2022" "repo smartsync" "Repo Manual" +.TH REPO "1" "April 2024" "repo smartsync" "Repo Manual" .SH NAME repo \- repo smartsync - manual page for repo smartsync .SH SYNOPSIS @@ -37,6 +37,11 @@ overwrite an existing git directory if it needs to point to a different object directory. WARNING: this may cause loss of data .TP +\fB\-\-force\-checkout\fR +force checkout even if it results in throwing away +uncommitted modifications. WARNING: this may cause +loss of data +.TP \fB\-\-force\-remove\-dirty\fR force remove projects with uncommitted modifications if projects no longer exist in the manifest. WARNING: diff --git a/man/repo-sync.1 b/man/repo-sync.1 index f006c03d..0327942a 100644 --- a/man/repo-sync.1 +++ b/man/repo-sync.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "November 2022" "repo sync" "Repo Manual" +.TH REPO "1" "April 2024" "repo sync" "Repo Manual" .SH NAME repo \- repo sync - manual page for repo sync .SH SYNOPSIS @@ -37,6 +37,11 @@ overwrite an existing git directory if it needs to point to a different object directory. WARNING: this may cause loss of data .TP +\fB\-\-force\-checkout\fR +force checkout even if it results in throwing away +uncommitted modifications. WARNING: this may cause +loss of data +.TP \fB\-\-force\-remove\-dirty\fR force remove projects with uncommitted modifications if projects no longer exist in the manifest. WARNING: @@ -185,6 +190,11 @@ The \fB\-\-force\-sync\fR option can be used to overwrite existing git directori they have previously been linked to a different object directory. WARNING: This may cause data to be lost since refs may be removed when overwriting. .PP +The \fB\-\-force\-checkout\fR option can be used to force git to switch revs even if the +index or the working tree differs from HEAD, and if there are untracked files. +WARNING: This may cause data to be lost since uncommitted changes may be +removed. +.PP The \fB\-\-force\-remove\-dirty\fR option can be used to remove previously used projects with uncommitted changes. WARNING: This may cause data to be lost since uncommitted changes may be removed with projects that no longer exist in the diff --git a/man/repo-upload.1 b/man/repo-upload.1 index b8f6677c..bb11dfa3 100644 --- a/man/repo-upload.1 +++ b/man/repo-upload.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "August 2022" "repo upload" "Repo Manual" +.TH REPO "1" "April 2024" "repo upload" "Repo Manual" .SH NAME repo \- repo upload - manual page for repo upload .SH SYNOPSIS @@ -30,6 +30,9 @@ add local branch name as a hashtag \fB\-l\fR LABELS, \fB\-\-label\fR=\fI\,LABELS\/\fR add a label when uploading .TP +\fB\-\-pd\fR=\fI\,PATCHSET_DESCRIPTION\/\fR, \fB\-\-patchset\-description\fR=\fI\,PATCHSET_DESCRIPTION\/\fR +description for patchset +.TP \fB\-\-re\fR=\fI\,REVIEWERS\/\fR, \fB\-\-reviewers\fR=\fI\,REVIEWERS\/\fR request reviews from these people .TP @@ -198,6 +201,12 @@ review.URL.uploadnotify: Control e\-mail notifications when uploading. https://gerrit\-review.googlesource.com/Documentation/user\-upload.html#notify .PP +review.URL.uploadwarningthreshold: +.PP +Repo will warn you if you are attempting to upload a large number of commits in +one or more branches. By default, the threshold is five commits. This option +allows you to override the warning threshold to a different value. +.PP References .PP Gerrit Code Review: https://www.gerritcodereview.com/ diff --git a/man/repo.1 b/man/repo.1 index 46425c69..bda68c39 100644 --- a/man/repo.1 +++ b/man/repo.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH REPO "1" "June 2023" "repo" "Repo Manual" +.TH REPO "1" "April 2024" "repo" "Repo Manual" .SH NAME repo \- repository management tool built on top of git .SH SYNOPSIS @@ -79,12 +79,6 @@ Download and checkout a change forall Run a shell command in each project .TP -gitc\-delete -Delete a GITC Client. -.TP -gitc\-init -Initialize a GITC Client. -.TP grep Print lines matching a pattern .TP