-
Notifications
You must be signed in to change notification settings - Fork 14.3k
[libc][docs] split up platform and arch support #120125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
nickdesaulniers
merged 4 commits into
llvm:main
from
nickdesaulniers:docs_platform_support
Dec 16, 2024
Merged
[libc][docs] split up platform and arch support #120125
nickdesaulniers
merged 4 commits into
llvm:main
from
nickdesaulniers:docs_platform_support
Dec 16, 2024
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@llvm/pr-subscribers-libc Author: Nick Desaulniers (nickdesaulniers) ChangesCreates a new toctree "Support" under which we have distinct links to arch,
Full diff: https://github.com/llvm/llvm-project/pull/120125.diff 3 Files Affected:
diff --git a/libc/docs/arch_support.rst b/libc/docs/arch_support.rst
new file mode 100644
index 00000000000000..ad8e85679c5c18
--- /dev/null
+++ b/libc/docs/arch_support.rst
@@ -0,0 +1,22 @@
+Architecture Support
+====================
+
+The currently continuously tested CPU architures are:
+
+* x86_64
+* aarch64
+* arm
+* riscv32
+* riscv64
+
+i386 support is in the works.
+
+The currently continuously tested GPU architures are:
+
+* amdgcn-amd-amdhsa
+* nvptx64-nvidia-cuda
+
+See "`Bringup on a New OS or Architecture <porting.html>`__" for more
+information. Please do first file a bug in
+`our issue tracker <https://github.com/llvm/llvm-project/labels/libc>`__ before
+starting a port that you plan to upstream.
diff --git a/libc/docs/index.rst b/libc/docs/index.rst
index a17717aff9f781..ad06547f8e6e16 100644
--- a/libc/docs/index.rst
+++ b/libc/docs/index.rst
@@ -31,25 +31,6 @@ LLVM-libc aspires to a unique place in the software ecosystem. The goals are:
.. __: https://github.com/llvm/llvm-project/tree/main/libc/fuzzing
-Platform Support
-================
-
-Most development is currently targeting Linux on x86_64, aarch64, arm, and
-RISC-V. Embedded/baremetal targets are supported on arm and RISC-V, and Windows
-and MacOS have limited support (may be broken). The Fuchsia platform is
-slowly replacing functions from its bundled libc with functions from this
-project.
-
-LLVM-libc does not guarantee backward compatibility with operating systems that have reached their EOL.
-Compatibility patches for obsolete operating systems will not be accepted.
-
-For Linux, we support kernel versions as listed on `kernel.org <https://kernel.org/>`_, including
-``longterm`` (not past EOL date), ``stable``, and ``mainline`` versions. We actively adopt new features
-from ``linux-next``.
-
-For Windows, we plan to support products within their lifecycle. Please refer to
-`Search Product and Services Lifecycle Information <https://learn.microsoft.com/en-us/lifecycle/products/?products=windows>`_ for more information.
-
ABI Compatibility
=================
@@ -73,10 +54,18 @@ stages there is no ABI stability in any form.
:maxdepth: 1
:caption: Status
- compiler_support
headers/index.rst
c23
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+ :caption: Support
+
+ arch_support
+ platform_support
+ compiler_support
+
.. toctree::
:hidden:
:maxdepth: 1
diff --git a/libc/docs/platform_support.rst b/libc/docs/platform_support.rst
new file mode 100644
index 00000000000000..e3ee9246e2563e
--- /dev/null
+++ b/libc/docs/platform_support.rst
@@ -0,0 +1,20 @@
+Platform Support
+================
+
+Development is currently mostly focused on Linux. MacOS and Windows has
+partial support, but has bitrot and isn't being tested continuously.
+
+LLVM-libc is currently being integrated into Android and Fuchsia operating
+systems via `overlay move <overlay_mode.html>`__.
+
+For Linux, we support kernel versions as listed on
+`kernel.org <https://kernel.org/>`_, including ``longterm`` (not past EOL
+date), ``stable``, and ``mainline`` versions. We actively adopt new features
+from ``linux-next``.
+
+For Windows, we plan to support products within their lifecycle. Please refer to
+`Search Product and Services Lifecycle Information <https://learn.microsoft.com/en-us/lifecycle/products/?products=windows>`_ for more information.
+
+LLVM-libc does not guarantee backward compatibility with operating systems that
+have reached their EOL. Compatibility patches for obsolete operating systems
+will not be accepted.
|
nickdesaulniers
commented
Dec 16, 2024
carlocab
reviewed
Dec 16, 2024
jhuber6
reviewed
Dec 16, 2024
jhuber6
approved these changes
Dec 16, 2024
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 llvm#118964 (comment). * Moved "Compiler Support" from Status toctree to new Support toctree.
Co-authored-by: Carlo Cabrera <[email protected]>
28abaef
to
4cb81c1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creates a new toctree "Support" under which we have distinct links to arch,
platform, and compiler support.
libc: FEnvImpl.h
error: static assertion failed due to requirement
#118964 (comment).