summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--contrib/completion/zsh/_devtools.in6
-rw-r--r--doc/man/pkgctl-version-check.1.asciidoc29
-rw-r--r--doc/man/pkgctl-version-upgrade.1.asciidoc24
-rw-r--r--doc/man/pkgctl-version.1.asciidoc29
-rw-r--r--doc/man/pkgctl.1.asciidoc2
-rw-r--r--src/lib/version.sh6
-rw-r--r--src/lib/version/check.sh12
-rw-r--r--src/lib/version/upgrade.sh12
-rw-r--r--src/pkgctl.in2
9 files changed, 84 insertions, 38 deletions
diff --git a/contrib/completion/zsh/_devtools.in b/contrib/completion/zsh/_devtools.in
index b427d20..34f90c6 100644
--- a/contrib/completion/zsh/_devtools.in
+++ b/contrib/completion/zsh/_devtools.in
@@ -277,7 +277,7 @@ _pkgctl_cmds=(
"release[Release step to commit, tag and upload build artifacts]"
"repo[Manage Git packaging repositories and their configuration]"
"search[Search for an expression across the GitLab packaging group]"
- "version[Package version related commands]"
+ "version[Check and manage package versions against upstream]"
)
_pkgctl_args=(
@@ -287,8 +287,8 @@ _pkgctl_args=(
_pkgctl_version_cmds=(
"pkgctl version command"
- "check[Check if there is an new upstream version available]"
- "upgrade[Upgrade the PKGBUILD according to the latest available upstream version]"
+ "check[Compares local package versions against upstream versions]"
+ "upgrade[Adjust the PKGBUILD to match the latest upstream version]"
)
_pkgctl_version_check_args=(
diff --git a/doc/man/pkgctl-version-check.1.asciidoc b/doc/man/pkgctl-version-check.1.asciidoc
index fa5401f..2543bcb 100644
--- a/doc/man/pkgctl-version-check.1.asciidoc
+++ b/doc/man/pkgctl-version-check.1.asciidoc
@@ -3,7 +3,7 @@ pkgctl-version-check(1)
Name
----
-pkgctl-version-check - Check if there is an new upstream version available
+pkgctl-version-check - Compares local package versions against upstream
Synopsis
--------
@@ -12,20 +12,24 @@ pkgctl version check [OPTIONS] [PKGBASE...]
Description
-----------
-Uses nvchecker, a .nvchecker.toml file and the version specified in the current
-PKGBUILDs pkgver to check if there is a newer package version available to
-which this package could possibly be upgraded.
+Compares the versions of packages in the local packaging repository against
+their latest upstream versions.
-The current working directory is used if no PKGBASE is specified.
+Upon execution, it generates a grouped list that provides detailed insights
+into each package's status. For each package, it displays the current local
+version alongside the latest version available upstream.
+
+Outputs a summary of up-to-date packages, out-of-date packages, and any check
+failures.
+
+This simplifies the maintenance of PKGBUILD files, reducing the manual effort
+required to track version changes from upstream sources.
Configuration
-------------
-To provide GitHub or GitLab tokens to nvchecker, a `keyfile.toml` will be
-supplied from `$XDG_CONFIG_HOME`/nvchecker.
-
-See the section on configuration files in linkman:nvchecker[1] for possible options
-which can be utilized in .nvchecker.toml.
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD. Refer to the configuration section in linkman:pkgctl-version[1].
Options
-------
@@ -36,8 +40,8 @@ Options
*-h, --help*::
Show a help text
-Errors
-------
+Exit Codes
+----------
On exit, return one of the following codes:
@@ -56,6 +60,7 @@ On exit, return one of the following codes:
See Also
--------
+linkman:pkgctl-version[1]
linkman:nvchecker[1]
include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-version-upgrade.1.asciidoc b/doc/man/pkgctl-version-upgrade.1.asciidoc
index 7f9cd96..68e6369 100644
--- a/doc/man/pkgctl-version-upgrade.1.asciidoc
+++ b/doc/man/pkgctl-version-upgrade.1.asciidoc
@@ -3,7 +3,7 @@ pkgctl-version-upgrade(1)
Name
----
-pkgctl-version-upgrade - Upgrade the PKGBUILD according to the latest available upstream version
+pkgctl-version-upgrade - Adjust the PKGBUILD to match the latest upstream version
Synopsis
--------
@@ -12,12 +12,25 @@ pkgctl version upgrade [OPTIONS] [PKGBASE...]
Description
-----------
-Upgrade the PKGBUILD according to the latest available upstream version.
+Streamlines the process of keeping PKGBUILD files up-to-date with the latest
+upstream versions.
-Uses nvchecker, a .nvchecker.toml file and the current PKGBUILD pkgver to check
-if there is a newer package version available.
+Upon execution, it automatically adjusts the PKGBUILD file, ensuring that the
+pkgver field is set to match the latest version available from the upstream
+source. In addition to updating the pkgver, this command also resets the pkgrel
+to 1.
-The current working directory is used if no PKGBASE is specified.
+Outputs a summary of upgraded packages, up-to-date packages, and any check
+failures.
+
+This simplifies the maintenance of PKGBUILD files, reducing the manual effort
+required to track and implement version changes from upstream sources.
+
+Configuration
+-------------
+
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD. Refer to the configuration section in linkman:pkgctl-version[1].
Options
-------
@@ -31,6 +44,7 @@ Options
See Also
--------
+linkman:pkgctl-version[1]
linkman:nvchecker[1]
include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-version.1.asciidoc b/doc/man/pkgctl-version.1.asciidoc
index e71becd..fa83314 100644
--- a/doc/man/pkgctl-version.1.asciidoc
+++ b/doc/man/pkgctl-version.1.asciidoc
@@ -3,7 +3,7 @@ pkgctl-version(1)
Name
----
-pkgctl-version - Package version related commands.
+pkgctl-version - Check and manage package versions against upstream
Synopsis
@@ -13,7 +13,28 @@ pkgctl version [OPTIONS] [SUBCOMMAND]
Description
-----------
-Package version related commands such as checking if a package is out of date.
+Commands related to package versions, including checks for outdated packages.
+
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD.
+
+Configuration
+-------------
+
+The `.nvchecker.toml` file must contain a section that matches the
+package's pkgbase. The pkgbase section within the `.nvchecker.toml` file
+specifies the source and method for checking the latest version of the
+corresponding package.
+
+For detailed information on the various configuration options available for the
+`.nvchecker.toml` file, refer to the configuration files section in
+linkman:nvchecker[1]. This documentation provides insights into the possible
+options that can be utilized to customize the version checking process.
+
+To supply GitHub or GitLab tokens to nvchecker, a `keyfile.toml` should be
+placed in the `$XDG_CONFIG_HOME`/nvchecker` directory. This keyfile is
+used for providing the necessary authentication tokens required for
+accessing the GitHub or GitLab API.
Options
-------
@@ -25,10 +46,10 @@ Subcommands
-----------
pkgctl version check::
- Check if there is an new upstream version available
+ Compares local package versions against upstream
pkgctl version upgrade::
- Upgrade the PKGBUILD according to the latest available upstream version
+ Adjust the PKGBUILD to match the latest upstream version
See Also
--------
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index 929ae9a..d9a1d8c 100644
--- a/doc/man/pkgctl.1.asciidoc
+++ b/doc/man/pkgctl.1.asciidoc
@@ -51,7 +51,7 @@ pkgctl search::
Search for an expression across the GitLab packaging group
pkgctl version::
- Package version related commands
+ Check and manage package versions against upstream
See Also
--------
diff --git a/src/lib/version.sh b/src/lib/version.sh
index 4340fca..ac810ae 100644
--- a/src/lib/version.sh
+++ b/src/lib/version.sh
@@ -15,11 +15,11 @@ pkgctl_version_usage() {
cat <<- _EOF_
Usage: ${COMMAND} [COMMAND] [OPTIONS]
- Package version related commands.
+ Check and manage package versions against upstream.
COMMANDS
- check Check if there is a newer version availble
- upgrade Upgrade the PKGBUILD according to the latest available upstream version
+ check Compares local package versions against upstream
+ upgrade Adjust the PKGBUILD to match the latest upstream version
OPTIONS
-h, --help Show this help text
diff --git a/src/lib/version/check.sh b/src/lib/version/check.sh
index cc8827d..006fd80 100644
--- a/src/lib/version/check.sh
+++ b/src/lib/version/check.sh
@@ -28,13 +28,15 @@ pkgctl_version_check_usage() {
cat <<- _EOF_
Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
- Uses nvchecker, a .nvchecker.toml file and the current PKGBUILD
- pkgver to check if there is a newer package version available.
+ Compares the versions of packages in the local packaging repository against
+ their latest upstream versions.
- The current working directory is used if no PKGBASE is specified.
+ Upon execution, it generates a grouped list that provides detailed insights
+ into each package's status. For each package, it displays the current local
+ version alongside the latest version available upstream.
- To provide GitHub or GitLab tokens to nvchecker, a keyfile.toml
- will be supplied from \${XDG_CONFIG_HOME}/nvchecker.
+ Outputs a summary of up-to-date packages, out-of-date packages, and any
+ check failures.
OPTIONS
-v, --verbose Display results including up-to-date versions
diff --git a/src/lib/version/upgrade.sh b/src/lib/version/upgrade.sh
index 70513ce..87744b0 100644
--- a/src/lib/version/upgrade.sh
+++ b/src/lib/version/upgrade.sh
@@ -24,12 +24,16 @@ pkgctl_version_upgrade_usage() {
cat <<- _EOF_
Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
- Upgrade the PKGBUILD according to the latest available upstream version
+ Streamlines the process of keeping PKGBUILD files up-to-date with the latest
+ upstream versions.
- Uses nvchecker, a .nvchecker.toml file and the current PKGBUILD
- pkgver to check if there is a newer package version available.
+ Upon execution, it automatically adjusts the PKGBUILD file, ensuring that the
+ pkgver field is set to match the latest version available from the upstream
+ source. In addition to updating the pkgver, this command also resets the pkgrel
+ to 1.
- The current working directory is used if no PKGBASE is specified.
+ Outputs a summary of upgraded packages, up-to-date packages, and any check
+ failures.
OPTIONS
-v, --verbose Display results including up-to-date versions
diff --git a/src/pkgctl.in b/src/pkgctl.in
index 9deb4b2..50c14b5 100644
--- a/src/pkgctl.in
+++ b/src/pkgctl.in
@@ -27,7 +27,7 @@ usage() {
release Release step to commit, tag and upload build artifacts
repo Manage Git packaging repositories and their configuration
search Search for an expression across the GitLab packaging group
- version Package version related commands
+ version Check and manage package versions against upstream
OPTIONS
-h, --help Show this help text
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-11-21 20:56:17 +0000