Skip to content

Commit 225d455

Browse files
committed
Documentation: update with the new PowerPC support
- To give details on support, add a "Constraints" column to the table. - To avoid listing all the architectures we support in the quick start, remove them. Note that this is anyhow explain in the top of the file, (with a reference to the arch support file). Take also the chance to explain more explicitly that `CC=clang` and `LLVM=1` are the way to go. Signed-off-by: Miguel Ojeda <[email protected]>
1 parent 7b4583e commit 225d455

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

Documentation/rust/arch-support.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,18 @@ Below is a general summary of architectures that currently work. Level of
1212
support corresponds to ``S`` values in the ``MAINTAINERS`` file.
1313

1414
.. list-table::
15-
:widths: 10 10
15+
:widths: 10 10 10
1616
:header-rows: 1
1717

1818
* - Architecture
1919
- Level of support
20-
* - arm64
20+
- Constraints
21+
* - ``arm64``
2122
- Maintained
22-
* - x86_64
23+
- None
24+
* - ``powerpc``
2325
- Maintained
26+
- ``ppc64le`` only, ``RUST_OPT_LEVEL >= 2``, Clang only
27+
* - ``x86``
28+
- Maintained
29+
- ``x86_64`` only

Documentation/rust/quick-start.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,17 @@ the example Rust driver ``Rust example`` (``CONFIG_RUST_EXAMPLE``).
159159
Building
160160
--------
161161

162-
Building a x86_64 or arm64 kernel with either GCC, Clang or a complete LLVM
163-
toolchain should all work. However, please note that using GCC is more
164-
experimental at the moment.
162+
Building a kernel with Clang or a complete LLVM toolchain is the best supported
163+
setup at the moment. That is::
164+
165+
make ARCH=... CROSS_COMPILE=... CC=clang -j...
166+
167+
or::
168+
169+
make ARCH=... CROSS_COMPILE=... LLVM=1 -j...
170+
171+
Using GCC also works for some configurations, but it is *very* experimental at
172+
the moment.
165173

166174

167175
Hacking

0 commit comments

Comments
 (0)