Skip to contentSkip to conversation

docs: submit-checklist: Expand on build tests against different word sizes

PATCH Applied Akira Yokosawa 2 participants 2 messages Jan 30, 2025 – Feb 10, 2025

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs: submit-checklist: Expand on build tests against different word sizes

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.

---
v2: Split out change in the English doc from v1 [1].
Keep Randy's Rb tag (as it was meant for the change in English doc).

[1] https://lore.kernel.org/[email protected]/
--

 Documentation/process/submit-checklist.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
Documentation/process/submit-checklist.rst +6 -3
index e531dd504b6c..88b6358258d7 100644
@@ -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

base-commit: 35ddd9f3c132a36856f58088bab06e873c1af871

Signature · 1 line
2.34.1
maintainer Applied
#1 lore raw
Quoted 25 lines · Akira Yokosawa

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.

---
v2: Split out change in the English doc from v1 [1].
Keep Randy's Rb tag (as it was meant for the change in English doc).

[1] https://lore.kernel.org/[email protected]/
--

 Documentation/process/submit-checklist.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
Documentation/process/submit-checklist.rst +0 -0
index e531dd504b6c..88b6358258d7 100644
@@ -91,9 +91,12 @@ Build your code
      fix any issues.
 
 2) Builds on multiple CPU architectures by using local cross-compile tools

Documentation/process/submit-checklist.rst Build your code · line 100

Quoted 10 lines
Documentation/process/submit-checklist.rst +6 -3
-   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.
 

Applied, thanks.

jon