summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Heusel <christian@heusel.eu>2023-04-15 19:44:22 +0200
committerLevente Polyak <anthraxx@archlinux.org>2023-05-20 00:08:13 +0200
commited966351410b39bfcec749df59dbc434a5dade1e (patch)
treee32d30d3bc2f14d5bc2b3b19b71491034a228a3a /doc
parentf961e2e94803dd46c4fa5941eb15a7d4612bd0f0 (diff)
downloaddevtools-ed966351410b39bfcec749df59dbc434a5dade1e.tar.xz
pkgctl repo: introduce the switch subcommand
Signed-off-by: Christian Heusel <christian@heusel.eu> Co-Authored-By: Levente Polyak <anthraxx@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/pkgctl-repo-switch.1.asciidoc36
-rw-r--r--doc/man/pkgctl-repo.1.asciidoc4
2 files changed, 40 insertions, 0 deletions
diff --git a/doc/man/pkgctl-repo-switch.1.asciidoc b/doc/man/pkgctl-repo-switch.1.asciidoc
new file mode 100644
index 0000000..ac12019
--- /dev/null
+++ b/doc/man/pkgctl-repo-switch.1.asciidoc
@@ -0,0 +1,36 @@
+pkgctl-repo-switch(1)
+=====================
+
+Name
+----
+pkgctl-repo-switch - Switch a package repository to a specified version
+
+Synopsis
+--------
+pkgctl repo switch [OPTIONS] [VERSION] [PKGBASE]...
+
+Description
+-----------
+
+Switch a package source repository to a specified version, tag or branch.
+The working tree and the index are updated to match the specified ref.
+
+If a version identifier is specified in the pacman version format, that
+identifier is automatically translated to the Git tag name accordingly.
+
+The current working directory is used if no PKGBASE is specified.
+
+Options
+-------
+
+*--discard-changes*::
+ Proceed even if the index or the working tree differs from HEAD. Both the
+ index and working tree are restored to match the switching target.
+
+*-f, --force*::
+ An alias for '--discard-changes'.
+
+*-h, --help*::
+ Show a help text
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-repo.1.asciidoc b/doc/man/pkgctl-repo.1.asciidoc
index 630afd8..713b474 100644
--- a/doc/man/pkgctl-repo.1.asciidoc
+++ b/doc/man/pkgctl-repo.1.asciidoc
@@ -41,6 +41,9 @@ pkgctl repo configure::
pkgctl repo create::
Create a new GitLab package repository
+pkgctl repo switch::
+ Switch a package repository to a specified version
+
pkgctl repo web::
Open the packaging repository's website
@@ -50,6 +53,7 @@ See Also
linkman:pkgctl-repo-clone[1]
linkman:pkgctl-repo-configure[1]
linkman:pkgctl-repo-create[1]
+linkman:pkgctl-repo-switch[1]
linkman:pkgctl-repo-web[1]
include::include/footer.asciidoc[]