Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-version.1.asciidoc
diff options
context:
space:
mode:
authorJelle van der Waa <jelle@archlinux.org>2024-01-21 13:25:57 +0100
committerChristian Heusel <christian@heusel.eu>2024-03-23 23:57:45 +0100
commit81f5e7b3b3f6e2687ebca03e212e0e7bc2da171f (patch)
treed84fce3878db9e52a8628e359e6d8882ebb22f78 /doc/man/pkgctl-version.1.asciidoc
parent01b6b0849ed098d4d3d8db3591443db3df6aa11b (diff)
feat(version): add command to automatically detect and setup nvchecker
Introduce a new version subcommand `setup` which does a best effort to generate the most minimal required .nvchecker.toml file for specific sources. It supports a wide range of common sources like: - Git, GitHub, GitLab, Hackage, NPM, PyPI, RubyGems, CPAN, crates.io The creation logic is based on matching a domain for a source which is something predictable and then simply passes an array of the url parts for every source creator to extract the useful bits out of the url array. Component: pkgctl version setup Co-authored-by: Levente Polyak <anthraxx@archlinux.org> Signed-off-by: Jelle van der Waa <jelle@archlinux.org>
Diffstat (limited to 'doc/man/pkgctl-version.1.asciidoc')
-rw-r--r--doc/man/pkgctl-version.1.asciidoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/man/pkgctl-version.1.asciidoc b/doc/man/pkgctl-version.1.asciidoc
index e6e4037..a72173b 100644
--- a/doc/man/pkgctl-version.1.asciidoc
+++ b/doc/man/pkgctl-version.1.asciidoc
@@ -26,6 +26,9 @@ 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.
+Use pkgctl-version-setup(1) to automatically detect and setup a basic nvchecker
+config based on the source array of the package PKGBUILD.
+
For detailed information on the various configuration options available for the
`.nvchecker.toml` file, refer to the configuration files section in
nvchecker(1). This documentation provides insights into the possible
@@ -48,6 +51,9 @@ Subcommands
pkgctl version check::
Compares local package versions against upstream
+pkgctl version setup::
+ Automatically detect and setup a basic nvchecker config
+
pkgctl version upgrade::
Adjust the PKGBUILD to match the latest upstream version
@@ -55,6 +61,7 @@ See Also
--------
pkgctl-version-check(1)
+pkgctl-version-setup(1)
pkgctl-version-upgrade(1)
include::include/footer.asciidoc[]