From 2ae3c69679d3619c06ec37bdc458cf522515c11e Mon Sep 17 00:00:00 2001 From: Hilton Chain Date: Sun, 30 Nov 2025 17:00:53 +0800 Subject: [PATCH] =?UTF-8?q?import:=20crate:=20Generate=20comments=20with?= =?UTF-8?q?=20=E2=80=98TODO=20REVIEW:=E2=80=99=20prefix.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This distinguishes them from manually added ones. When committing changes, these ‘TODO REVIEW’ comments should be addressed and removed first. If you're working with Rust packaging, please update your local Guix to this commit to apply the change. * guix/import/crate.scm (cargo-lock->expressions): Generate comments with ‘TODO REVIEW:’ prefix. * tests/import/crate.scm ("crate-lockfile-import"): Don't check the exact comment string. * doc/guix-cookbook.texi (Common Workflow for Rust Packaging), * gnu/packages/rust-crates.scm: Adjust accordingly. Change-Id: I76b914b49be46d04cc61b101b6bc9e31cadb7f07 Signed-off-by: Rutherther Merges: #4567 --- doc/guix-cookbook.texi | 4 ++-- gnu/packages/rust-crates.scm | 22 +++++++++++----------- guix/import/crate.scm | 4 ++-- tests/import/crate.scm | 4 +--- 4 files changed, 16 insertions(+), 18 deletions(-) diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi index 2107228dbfc..eea1f96bf1b 100644 --- a/doc/guix-cookbook.texi +++ b/doc/guix-cookbook.texi @@ -1734,8 +1734,8 @@ At this stage, the package @code{cargo-audit} is buildable. @item Finally we'll unbundle the vendored dependencies. The lockfile importer -inserts @code{TODO:} comments for libraries with high probability of -bundled dependencies. @code{cargo-build-system} also performs +inserts @code{TODO REVIEW:} comments for libraries with high probability +of bundled dependencies. @code{cargo-build-system} also performs additional check for binary files in its @code{check-for-pregenerated-files} phase, which usually indicates bundling: diff --git a/gnu/packages/rust-crates.scm b/gnu/packages/rust-crates.scm index 5ba47758020..0854bb262bb 100644 --- a/gnu/packages/rust-crates.scm +++ b/gnu/packages/rust-crates.scm @@ -9896,7 +9896,7 @@ "0yp3rz7vrn9mmqdpkds426r1p9vs6i8mkxx8ryqdfadr0s2q0s0q")) (define rust-js-sys-0.3.76 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "js-sys" "0.3.76" "1dz7v777h2j38wkf8k5iwkfxskn6nff2cdv2jsslyxkpn2svc5v7")) @@ -10230,7 +10230,7 @@ "0ssx5f16hhif8zjdd1fz4cwn1cwjslwcbssm2xs7l93g2i6hw6h0")) (define rust-libbz2-rs-sys-0.2.1 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "libbz2-rs-sys" "0.2.1" "1jzw1nz25k7b9rbq7czqyvckgxxj90d3bdc020mpravqb06zhnvp")) @@ -10335,7 +10335,7 @@ "0v34vjczpj8hzxnx1nj5cxwf326m91gn7bi3l3zkfg72xij94kvz")) (define rust-libdisplay-info-sys-0.3.0 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "libdisplay-info-sys" "0.3.0" "07xmkc2aqcdn6d58321y87rd3gzdr4nx3ncm1mmrr7w1p1ahsn96")) @@ -10637,7 +10637,7 @@ (define rust-libspa-sys-0.8.0.fd3d8f7 package:rust-pipewire-0.8.0.fd3d8f7) (define rust-libspa-sys-0.9.2 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "libspa-sys" "0.9.2" "1q66vim2wha1rdglqn5w0i42z59pa9s5s8sqj37xxdifbm2lj44h")) @@ -10859,7 +10859,7 @@ "1aq7r2g7786hyxhv40spzf2nhag5xbw2axxc1k8z5k1dsgdm4v6j")) (define rust-linux-raw-sys-0.4.5 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "linux-raw-sys" "0.4.5" "00w52pb2cb4b2880ksyzagmzbyjdmp9ac0w3qfvjv3453fnzvg2p")) @@ -13966,7 +13966,7 @@ (define rust-pipewire-sys-0.8.0.fd3d8f7 package:rust-pipewire-0.8.0.fd3d8f7) (define rust-pipewire-sys-0.9.2 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "pipewire-sys" "0.9.2" "0dpa8q10b9cja5z5r5zgb8q27pnpla7kn3h91c11gjnnw3z8l0nb")) @@ -15548,7 +15548,7 @@ "1glcyqvryv2zj6kjbfji0cldrkincqx3ds3wjwl4qnsnig15wn5w")) (define rust-reflink-0.1.3.e8d93b4 - ;; TODO: Define standalone package if this is a workspace. + ;; TODO REVIEW: Define standalone package if this is a workspace. (origin (method git-fetch) (uri (git-reference (url "https://github.com/nicokoch/reflink") @@ -17827,7 +17827,7 @@ (define rust-smithay-0.7.0.20d2dac package:rust-smithay-0.7.0.20d2dac) (define rust-smithay-0.7.0.d743e1a - ;; TODO: Define standalone package if this is a workspace. + ;; TODO REVIEW: Define standalone package if this is a workspace. (origin (method git-fetch) (uri (git-reference (url "https://github.com/Smithay/smithay.git") @@ -19795,7 +19795,7 @@ "1c3jn4ka61l4qw0g8w9lw5l0fwid4wz76x2cvdb3za81a4cp171i")) (define rust-tracy-client-sys-0.27.0 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "tracy-client-sys" "0.27.0" "07yv23nh5wj6gd7l36ipxg0yr5cgkjzqyqamlybk0as6f2n93crg")) @@ -21712,12 +21712,12 @@ "15qbbdbhyz02srvm01p0cvlh0pvmbbin9hislp0yx8rvnbs9jfz3")) (define rust-web-sys-0.3.76 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "web-sys" "0.3.76" "1g0j3kii20mh7hqmdajz2r4c21zynb9h9h026wymalkx88ip5p84")) (define rust-web-sys-0.3.69 - ;; TODO: Check bundled sources. + ;; TODO REVIEW: Check bundled sources. (crate-source "web-sys" "0.3.69" "1vqkxk935xa8zcnsi4bd88sb267ly2i24xl1yiq26d1n32hskbvp")) diff --git a/guix/import/crate.scm b/guix/import/crate.scm index c25a66c644f..1d3dc75de6f 100644 --- a/guix/import/crate.scm +++ b/guix/import/crate.scm @@ -300,7 +300,7 @@ referencing all imported sources." (string-append (crate-name->package-name name) "-" version)) ,@(if (or (string-suffix? "src" name) (string-suffix? "sys" name)) - (list (comment ";; TODO: Check bundled sources.\n" #f)) + (list (comment ";; TODO REVIEW: Check bundled sources.\n" #f)) '()) (crate-source ,name ,version ,(bytevector->nix-base32-string @@ -327,7 +327,7 @@ referencing all imported sources." ,(string->symbol (string-append (crate-name->package-name name) "-" version)) ,(comment - ";; TODO: Define standalone package if this is a workspace.\n" + ";; TODO REVIEW: Define standalone package if this is a workspace.\n" #f) (origin (method git-fetch) diff --git a/tests/import/crate.scm b/tests/import/crate.scm index d0fa582ad1a..e65609896af 100644 --- a/tests/import/crate.scm +++ b/tests/import/crate.scm @@ -311,9 +311,7 @@ version = \"25.2.0\"\n" port))) "aho-corasick" "1.1.3" "05mrpkvdgp5d20y2p989f187ry9diliijgwrs254fs9s1m1x6q4f")) (define rust-smithay-0.4.0.0cd3345 - ,($ - ";; TODO: Define standalone package if this is a workspace.\n" - #f) + ,(? comment?) (origin (method git-fetch) (uri (git-reference