(address . guix-patches@gnu.org)(name . Maxime Devos)(address . maximedevos@telenet.be)
79bb8251f2c668c1af68b6fc5362149e3987f7e5.1692623240.git.maximedevos@telenet.be
"CC=gcc" is almost always incorrect; people often just don't
notice the incorrectness because they are compiling natively.
I don't know of any packages in Guix where "CC=gcc" is correct.
"guix style" partially made things worse, so I partially ignored it.
* guix/lint.scm (check-compiler-for-target): New linter.
* tests/lint.scm
("compiler-for-target: unconditional CC=gcc is unacceptable")
("compiler-for-target: looks through G-expressions")
("compiler-for-target: (cc-for-target) is acceptable"): Test it.
(Remove before applying)
I was cross-compiling something (libical), which failed, so I wrote a
linter to prevent a class of cross-compilation problems. I
accidentally tested for some other class of cross-compilation
problems, but whatever, this is still useful.
p.s.: Does anyone know any Git documentation in the scissors stuff?
---
guix/lint.scm | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
tests/lint.scm | 23 ++++++++++++++++++++++-
2 files changed, 71 insertions(+), 2 deletions(-)
Toggle diff (128 lines)
diff --git a/guix/lint.scm b/guix/lint.scm
index d173563e51..a517b96a88 100644
--- a/guix/lint.scm
+++ b/guix/lint.scm
@@ -12,7 +12,7 @@
;;; Copyright © 2020 Chris Marusich <cmmarusich@gmail.com>
;;; Copyright © 2020 Timothy Sample <samplet@ngyro.com>
;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
-;;; Copyright © 2021, 2022 Maxime Devos <maximedevos@telenet.be>
+;;; Copyright © 2021-2023 Maxime Devos <maximedevos@telenet.be>
;;; Copyright © 2021 Brice Waegeneire <brice@waegenei.re>
;;;
;;; This file is part of GNU Guix.
@@ -114,6 +114,7 @@ (define-module (guix lint)
check-profile-collisions
check-haskell-stackage
check-tests-true
+ check-compiler-for-target
lint-warning
lint-warning?
@@ -311,6 +312,49 @@ (define (check-tests-true package)
#:field 'arguments))
'()))
+(define (check-compiler-for-target package)
+ "Check that cross-compilers are used when cross-compiling, by inspecting
+#:make-flags."
+ (define (make-compiler-warning variable=value)
+ (define =-index (string-index variable=value #\=))
+ (define variable (substring variable=value 0 =-index))
+ (define value (substring variable=value (+ =-index 1)))
+ (make-warning package
+ (G_ "'~0@*~a' should be set to '~1@*~a' instead of '~2@*~a'")
+ (list variable
+ (match variable
+ ("AR" "(ar-for-target)")
+ ("AS" "(as-for-target)")
+ ("CC" "(cc-for-target)")
+ ("CXX" "(cxx-for-target)")
+ ("LD" "(ld-for-target)")
+ ("PKG_CONFIG" "(pkg-config-for-target)"))
+ value)
+ #:field 'arguments))
+ (define (find-incorrect-compilers l)
+ (match l
+ ((or "AR=ar"
+ "AS=as"
+ ;; 'cc' doesn't actually exist in Guix, but if it did,
+ ;; it would be incorrect to use it w.r.t. cross-compilation.
+ "CC=cc" "CC=gcc" "CC=clang"
+ "CXX=g++"
+ "LD=ld"
+ "PKG_CONFIG=pkg-config")
+ (list (make-compiler-warning l)))
+ ((x . y)
+ (append (find-incorrect-compilers x)
+ (find-incorrect-compilers y)))
+ (_ '())))
+ (parameterize ((%current-target-system "aarch64-linux-gnu"))
+ (apply (lambda* (#:key make-flags #:allow-other-keys)
+ (define make-flags/sexp
+ (if (gexp? make-flags/sexp)
+ (gexp->approximate-sexp make-flags)
+ make-flags))
+ (find-incorrect-compilers make-flags/sexp))
+ (package-arguments package))))
+
(define (properly-starts-sentence? s)
(string-match "^[(\"'`[:upper:][:digit:]]" s))
@@ -1864,6 +1908,10 @@ (define %local-checkers
(name 'tests-true)
(description "Check if tests are explicitly enabled")
(check check-tests-true))
+ (lint-checker
+ (name 'compiler-for-target)
+ (description "Check that cross-compilers are used when cross-compiling")
+ (check check-compiler-for-target))
(lint-checker
(name 'description)
(description "Validate package descriptions")
diff --git a/tests/lint.scm b/tests/lint.scm
index b91bd053c5..45359d3783 100644
--- a/tests/lint.scm
+++ b/tests/lint.scm
@@ -10,7 +10,7 @@
;;; Copyright © 2020 Timothy Sample <samplet@ngyro.com>
;;; Copyright © 2020 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
-;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be>
+;;; Copyright © 2021, 2023 Maxime Devos <maximedevos@telenet.be>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -342,6 +342,27 @@ (define (warning-contains? str warnings)
`(#:tests? ,(not (%current-target-system)))))))
(check-tests-true pkg)))
+(test-equal "compiler-for-target: unconditional CC=gcc is unacceptable"
+ "'CC' should be set to '(cc-for-target)' instead of 'gcc'"
+ (single-lint-warning-message
+ (check-compiler-for-target
+ (dummy-package "x" (arguments '(#:make-flags '("CC=gcc")))))))
+
+
+(test-equal "compiler-for-target: looks through G-expressions"
+ "'CC' should be set to '(cc-for-target)' instead of 'gcc'"
+ (single-lint-warning-message
+ (check-compiler-for-target
+ (dummy-package "x" (arguments '(#:make-flags #~'("CC=gcc")))))))
+
+(test-equal "compiler-for-target: (cc-for-target) is acceptable"
+ '()
+ (check-compiler-for-target
+ (dummy-package "x"
+ (arguments
+ (list #:make-flags
+ #~(list (string-append "CC=" (cc-for-target))))))))
+
;; The emacs-build-system sets #:tests? #f by default.
(test-equal "tests-true: #:tests? #t acceptable for emacs packages"
'()
base-commit: 707682ac75a81f41a478c2c51672ca49b98fa6eb
prerequisite-patch-id: b6e78e4ce45fc555f83ef70ba4b158046f750dc3
--
2.41.0