summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLevente Polyak <anthraxx@archlinux.org>2023-12-21 21:40:57 +0100
committerLevente Polyak <anthraxx@archlinux.org>2024-01-05 01:01:52 +0100
commit4425913e4f3bfd3cb346c38e13a10f0002615a55 (patch)
tree84a646530a6b5082948040fd592a0707eb14dd52
parent2a1e8aebaf8e883270b617a743668e34b6db3d92 (diff)
downloaddevtools-4425913e4f3bfd3cb346c38e13a10f0002615a55.tar.xz
chore(build): use more intuitive update-checksums option for humans
The philosophy of our CLI is to provide options that better match human expectations in an intuitive way rather than mimic wording of previous tools with abbreviation. Component: pkgctl build Signed-off-by: Levente Polyak <anthraxx@archlinux.org>
-rw-r--r--contrib/completion/bash/devtools.in2
-rw-r--r--contrib/completion/zsh/_devtools.in2
-rw-r--r--doc/man/pkgctl-build.1.asciidoc8
-rw-r--r--src/lib/build/build.sh12
4 files changed, 14 insertions, 10 deletions
diff --git a/contrib/completion/bash/devtools.in b/contrib/completion/bash/devtools.in
index 83264ce..b974257 100644
--- a/contrib/completion/bash/devtools.in
+++ b/contrib/completion/bash/devtools.in
@@ -179,7 +179,7 @@ _pkgctl_build_args=(
--pkgver
--pkgrel
--rebuild
- --updpkgsums
+ --update-checksums
-e --edit
-r --release
diff --git a/contrib/completion/zsh/_devtools.in b/contrib/completion/zsh/_devtools.in
index b82ece4..35ab2dc 100644
--- a/contrib/completion/zsh/_devtools.in
+++ b/contrib/completion/zsh/_devtools.in
@@ -50,7 +50,7 @@ _pkgctl_build_args=(
'--pkgver=[Set pkgver, reset pkgrel and update checksums]:pkgver:'
'--pkgrel=[Set pkgrel to a given value]:pkgrel:'
'--rebuild[Increment the pkgrel variable]'
- '--updpkgsums[Regenerate the checksums]'
+ '--update-checksums[Force computation and update of the checksums (disables auto-detection)]'
'(-e --edit)'{-e,--edit}'[Edit the PKGBUILD before building]'
'(-r --release)'{-r,--release}'[Automatically commit, tag and release after building]'
'(-m --message=)'{-m,--message=}"[Use the given <msg> as the commit message]:message:"
diff --git a/doc/man/pkgctl-build.1.asciidoc b/doc/man/pkgctl-build.1.asciidoc
index 3f2d44e..12deaaa 100644
--- a/doc/man/pkgctl-build.1.asciidoc
+++ b/doc/man/pkgctl-build.1.asciidoc
@@ -63,8 +63,12 @@ PKGBUILD Options
*--rebuild*::
Increment the current pkgrel variable
-*--updpkgsums*::
- Regenerate the checksums
+*--update-checksums*::
+ Force computation and update of the checksums by disabling auto-detection. +
+ Should only be used in special circumstances, like when adding new patch
+ files to the source array. During regular packaging operations, checksums
+ are either automatically updated when upgrading a package using `--pkgver`
+ or should remain immutable during rebuilds.
*-e, --edit*::
Edit the PKGBUILD before building
diff --git a/src/lib/build/build.sh b/src/lib/build/build.sh
index 2b9d4cf..e0982e4 100644
--- a/src/lib/build/build.sh
+++ b/src/lib/build/build.sh
@@ -58,7 +58,7 @@ pkgctl_build_usage() {
--pkgver=PKGVER Set pkgver, reset pkgrel and update checksums
--pkgrel=PKGREL Set pkgrel to a given value
--rebuild Increment the current pkgrel variable
- --updpkgsums Regenerate the checksums
+ --update-checksums Force computation and update of the checksums (disables auto-detection)
-e, --edit Edit the PKGBUILD before building
RELEASE OPTIONS
@@ -108,7 +108,7 @@ pkgctl_build() {
exit 1
fi
- local UPDPKGSUMS=0
+ local UPDATE_CHECKSUMS=0
local EDIT=0
local REBUILD=0
local OFFLOAD=0
@@ -165,7 +165,7 @@ pkgctl_build() {
pkgctl_build_check_option_group_ver '--pkgver' "${PKGVER}" "${PKGREL}" "${REBUILD}"
PKGVER="${1#*=}"
PKGREL=1
- UPDPKGSUMS=1
+ UPDATE_CHECKSUMS=1
shift
;;
--pkgrel=*)
@@ -173,8 +173,8 @@ pkgctl_build() {
PKGREL="${1#*=}"
shift
;;
- --updpkgsums)
- UPDPKGSUMS=1
+ --update-checksums)
+ UPDATE_CHECKSUMS=1
shift
;;
--rebuild)
@@ -407,7 +407,7 @@ pkgctl_build() {
# update checksums if any sources are declared
- if (( UPDPKGSUMS )) && (( ${#source[@]} >= 1 )); then
+ if (( UPDATE_CHECKSUMS )) && (( ${#source[@]} >= 1 )); then
updpkgsums
fi