]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
docs: submit-checklist: Expand on build tests against different word sizes
authorAkira Yokosawa <akiyks@gmail.com>
Thu, 30 Jan 2025 07:28:09 +0000 (16:28 +0900)
committerJonathan Corbet <corbet@lwn.net>
Mon, 10 Feb 2025 18:00:44 +0000 (11:00 -0700)
Existing sentence on cross-compilation that mentions ppc64 does not
make much sense in today's perspective.

Expand it for the benefits of testing against architectures of
different word sizes and endianness.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/05c0b99c-c2e9-4702-90fd-8a4127586424@gmail.com
Documentation/process/submit-checklist.rst

index e531dd504b6c2813aa845530c9cfcb808b85dc18..88b6358258d7628a1a9a8e50af2f8b54cbb05aaa 100644 (file)
@@ -91,9 +91,12 @@ Build your code
      fix any issues.
 
 2) Builds on multiple CPU architectures by using local cross-compile tools
-   or some other build farm. Note that ppc64 is a good architecture for
-   cross-compilation checking because it tends to use ``unsigned long`` for
-   64-bit quantities.
+   or some other build farm.
+   Note that testing against architectures of different word sizes
+   (32- and 64-bit) and different endianness (big- and little-) is effective
+   in catching various portability issues due to false assumptions on
+   representable quantity range, data alignment, or endianness, among
+   others.
 
 3) Newly-added code has been compiled with ``gcc -W`` (use
    ``make KCFLAGS=-W``).  This will generate lots of noise, but is good