[bug#76109] doc: Mention --check --no-grafts as a way to force-rebuild packages.

Message ID 005108696881e41414551282c5fdca15bbbd9844.1738885372.git.Rostislav.Svoboda@gmail.com
State New
Headers
Series [bug#76109] doc: Mention --check --no-grafts as a way to force-rebuild packages. |

Commit Message

Rostislav Svoboda Feb. 6, 2025, 11:43 p.m. UTC
  * doc/guix.texi (On Trusting Binaries): Document that combining --check and
--no-grafts with 'guix build' forces the rebuild of a package.

Change-Id: I4eb6be04243a52f70d0fc298f76e62f10e3d376e
---
 doc/guix.texi | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)


base-commit: 3afa3aa73a35364f8c429334ac68f50f719f5b22
  

Comments

Leo Famulari Feb. 7, 2025, 12:05 a.m. UTC | #1
On Fri, Feb 07, 2025 at 12:43:36AM +0100, Rostislav Svoboda wrote:
> * doc/guix.texi (On Trusting Binaries): Document that combining --check and
> --no-grafts with 'guix build' forces the rebuild of a package.

Thanks, this is really useful information that most people have had to
learn by asking.

> +@command{guix build --check}}).  To force a full rebuild of a package
> +(ignoring security updates via grafts), use @option{--check} together
> +with @option{--no-grafts} (@pxref{Common Build Options,
> +@option{--no-grafts}}).

Grafts are not always present in the codebase (hard to believe, I know),
so can you adjust it to something like "(ignoring security updates via
grafts, which are often present)"?
  

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 9f1e4bf0f0..20d9debfbf 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -3978,7 +3978,10 @@  On Trusting Binaries
 challenge}).  Similarly, the @option{--check} option of @command{guix
 build} allows users to check whether previously-installed substitutes
 are genuine by rebuilding them locally (@pxref{build-check,
-@command{guix build --check}}).
+@command{guix build --check}}).  To force a full rebuild of a package
+(ignoring security updates via grafts), use @option{--check} together
+with @option{--no-grafts} (@pxref{Common Build Options,
+@option{--no-grafts}}).
 
 In the future, we want Guix to have support to publish and retrieve
 binaries to/from other users, in a peer-to-peer fashion.  If you would