From 0a1f533e2835c856473e3e4046341a4d2f66764b Mon Sep 17 00:00:00 2001 From: Roger Shimizu Date: Sun, 20 Jun 2021 21:41:05 +0900 Subject: Add script 'release/update-manpages' to generate manpages Debian package started to ship manpages for repo since 2.8 [1] And it's about for one year. So I think it should be upstreamed. The script depends on help2man, which is available in both debian [2] and ubuntu [3]. [1] https://tracker.debian.org/news/1150858/accepted-repo-28-1-source-into-unstable [2] https://tracker.debian.org/pkg/help2man [3] https://launchpad.net/ubuntu/+source/help2man Change-Id: Ide2b356d0944ebde34cc96c6d5a782655bd72288 Signed-off-by: Roger Shimizu Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/309782 Reviewed-by: Mike Frysinger --- man/repo-smartsync.1 | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 man/repo-smartsync.1 (limited to 'man/repo-smartsync.1') diff --git a/man/repo-smartsync.1 b/man/repo-smartsync.1 new file mode 100644 index 00000000..ad98b479 --- /dev/null +++ b/man/repo-smartsync.1 @@ -0,0 +1,117 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man. +.TH REPO "1" "July 2021" "repo smartsync" "Repo Manual" +.SH NAME +repo \- repo smartsync - manual page for repo smartsync +.SH SYNOPSIS +.B repo +\fI\,smartsync \/\fR[\fI\,\/\fR...] +.SH DESCRIPTION +Summary +.PP +Update working tree to the latest known good revision +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR +number of jobs to run in parallel (default: 1) +.TP +\fB\-\-jobs\-network\fR=\fI\,JOBS\/\fR +number of network jobs to run in parallel (defaults to +\fB\-\-jobs\fR) +.TP +\fB\-\-jobs\-checkout\fR=\fI\,JOBS\/\fR +number of local checkout jobs to run in parallel +(defaults to \fB\-\-jobs\fR) +.TP +\fB\-f\fR, \fB\-\-force\-broken\fR +obsolete option (to be deleted in the future) +.TP +\fB\-\-fail\-fast\fR +stop syncing after first error is hit +.TP +\fB\-\-force\-sync\fR +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\-remove\-dirty\fR +force remove projects with uncommitted modifications +if projects no longer exist in the manifest. WARNING: +this may cause loss of data +.TP +\fB\-l\fR, \fB\-\-local\-only\fR +only update working tree, don't fetch +.TP +\fB\-\-no\-manifest\-update\fR, \fB\-\-nmu\fR +use the existing manifest checkout as\-is. (do not +update to the latest revision) +.TP +\fB\-n\fR, \fB\-\-network\-only\fR +fetch only, don't update working tree +.TP +\fB\-d\fR, \fB\-\-detach\fR +detach projects back to manifest revision +.TP +\fB\-c\fR, \fB\-\-current\-branch\fR +fetch only current branch from server +.TP +\fB\-\-no\-current\-branch\fR +fetch all branches from server +.TP +\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml +temporary manifest to use for this sync +.TP +\fB\-\-clone\-bundle\fR +enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS +.TP +\fB\-\-no\-clone\-bundle\fR +disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS +.TP +\fB\-u\fR MANIFEST_SERVER_USERNAME, \fB\-\-manifest\-server\-username\fR=\fI\,MANIFEST_SERVER_USERNAME\/\fR +username to authenticate with the manifest server +.TP +\fB\-p\fR MANIFEST_SERVER_PASSWORD, \fB\-\-manifest\-server\-password\fR=\fI\,MANIFEST_SERVER_PASSWORD\/\fR +password to authenticate with the manifest server +.TP +\fB\-\-fetch\-submodules\fR +fetch submodules from server +.TP +\fB\-\-use\-superproject\fR +use the manifest superproject to sync projects +.TP +\fB\-\-no\-use\-superproject\fR +disable use of manifest superprojects +.TP +\fB\-\-tags\fR +fetch tags +.TP +\fB\-\-no\-tags\fR +don't fetch tags +.TP +\fB\-\-optimized\-fetch\fR +only fetch projects fixed to sha1 if revision does not +exist locally +.TP +\fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR +number of times to retry fetches on transient errors +.TP +\fB\-\-prune\fR +delete refs that no longer exist on the remote +.SS Logging options: +.TP +\fB\-v\fR, \fB\-\-verbose\fR +show all output +.TP +\fB\-q\fR, \fB\-\-quiet\fR +only show errors +.SS repo Version options: +.TP +\fB\-\-no\-repo\-verify\fR +do not verify repo source code +.PP +Run `repo help smartsync` to view the detailed manual. +.SH DETAILS +.PP +The 'repo smartsync' command is a shortcut for sync \fB\-s\fR. -- cgit v1.2.3-54-g00ecf