Skip to content

Commit 13449c3

Browse files
[libc][docs] split up platform and arch support (#120125)
Creates a new toctree "Support" under which we have distinct links to arch, platform, and compiler support. * Moved "Platform Support" from index landing page to new doc. * Created explicit "Architecture Support". Requested in #118964 (comment). * Moved "Compiler Support" from Status toctree to new Support toctree. --------- Co-authored-by: Carlo Cabrera <[email protected]>
1 parent a8456c9 commit 13449c3

File tree

3 files changed

+50
-19
lines changed

3 files changed

+50
-19
lines changed

libc/docs/arch_support.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Architecture Support
2+
====================
3+
4+
The currently continuously tested architectures are:
5+
6+
* aarch64
7+
* amdgpu
8+
* arm
9+
* nvptx
10+
* riscv32
11+
* riscv64
12+
* x86_64
13+
14+
i386 support is [in the works](https://github.com/llvm/llvm-project/issues/93709).
15+
16+
See "`Bringup on a New OS or Architecture <porting.html>`__" for more
17+
information. Please do first file a bug in
18+
`our issue tracker <https://github.com/llvm/llvm-project/labels/libc>`__ before
19+
starting a port that you plan to upstream.

libc/docs/index.rst

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,24 +35,6 @@ LLVM-libc aspires to a unique place in the software ecosystem. The goals are:
3535
algorithms.
3636
- `Fuzzing <https://github.com/llvm/llvm-project/tree/main/libc/fuzzing>`__
3737

38-
Platform Support
39-
================
40-
41-
Most development is currently targeting Linux on x86_64, aarch64, arm, and
42-
RISC-V. Embedded/baremetal targets are supported on arm and RISC-V, and Windows
43-
and MacOS have limited support (may be broken). The Fuchsia platform is
44-
slowly replacing functions from its bundled libc with functions from this
45-
project.
46-
47-
LLVM-libc does not guarantee backward compatibility with operating systems that have reached their EOL.
48-
Compatibility patches for obsolete operating systems will not be accepted.
49-
50-
For Linux, we support kernel versions as listed on `kernel.org <https://kernel.org/>`_, including
51-
``longterm`` (not past EOL date), ``stable``, and ``mainline`` versions. We actively adopt new features
52-
from ``linux-next``.
53-
54-
For Windows, we plan to support products within their lifecycle. Please refer to
55-
`Search Product and Services Lifecycle Information <https://learn.microsoft.com/en-us/lifecycle/products/?products=windows>`_ for more information.
5638

5739
.. toctree::
5840
:hidden:
@@ -70,10 +52,18 @@ For Windows, we plan to support products within their lifecycle. Please refer to
7052
:maxdepth: 1
7153
:caption: Status
7254

73-
compiler_support
7455
headers/index.rst
7556
c23
7657

58+
.. toctree::
59+
:hidden:
60+
:maxdepth: 1
61+
:caption: Support
62+
63+
arch_support
64+
platform_support
65+
compiler_support
66+
7767
.. toctree::
7868
:hidden:
7969
:maxdepth: 1

libc/docs/platform_support.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Platform Support
2+
================
3+
4+
Development is currently mostly focused on Linux. MacOS and Windows has
5+
partial support, but has bitrot and isn't being tested continuously.
6+
7+
LLVM-libc is currently being integrated into Android and Fuchsia operating
8+
systems via `overlay mode <overlay_mode.html>`__.
9+
10+
For Linux, we support kernel versions as listed on
11+
`kernel.org <https://kernel.org/>`_, including ``longterm`` (not past EOL
12+
date), ``stable``, and ``mainline`` versions. We actively adopt new features
13+
from ``linux-next``.
14+
15+
For Windows, we plan to support products within their lifecycle. Please refer to
16+
`Search Product and Services Lifecycle Information <https://learn.microsoft.com/en-us/lifecycle/products/?products=windows>`_ for more information.
17+
18+
LLVM-libc does not guarantee backward compatibility with operating systems that
19+
have reached their EOL. Compatibility patches for obsolete operating systems
20+
will not be accepted.
21+
22+
For GPU, reference `our GPU docs <gpu/index.html>`__.

0 commit comments

Comments
 (0)