mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-04-28 02:46:06 +00:00
Code Issues Projects Releases Wiki Activity
llvm-project/libc/docs/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

89 lines
2.6 KiB
ReStructuredText
Raw Normal View History

[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
==================
The LLVM C Library
==================
Rewrite much of the index page for libc The prior page was the proposal doc, this one is now more about what the project intends to do, written in the present tense. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D119379
2022-02-16 03:45:57 +00:00
[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
.. warning::
The libc is not complete. If you need a fully functioning C library right
now, you should continue to use your standard system libraries.
Add a proposal for a libc project under the LLVM umbrella. Reviewers: chandlerc, dlj, echristo, hfinkel, jfb, zturner Subscribers: dexonsmith, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64939 llvm-svn: 369012
2019-08-15 15:50:42 +00:00
Replace Goals and Why section with Introduction Rewrite the introduction of the page to state clearly the goals of LLVM's libc project. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D127174
2022-06-07 06:52:02 +00:00
Introduction
============
Add a proposal for a libc project under the LLVM umbrella. Reviewers: chandlerc, dlj, echristo, hfinkel, jfb, zturner Subscribers: dexonsmith, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64939 llvm-svn: 369012
2019-08-15 15:50:42 +00:00
Replace Goals and Why section with Introduction Rewrite the introduction of the page to state clearly the goals of LLVM's libc project. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D127174
2022-06-07 06:52:02 +00:00
The libc aspires to a unique place in the software ecosystem. The goals are:
Add a proposal for a libc project under the LLVM umbrella. Reviewers: chandlerc, dlj, echristo, hfinkel, jfb, zturner Subscribers: dexonsmith, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64939 llvm-svn: 369012
2019-08-15 15:50:42 +00:00
Replace Goals and Why section with Introduction Rewrite the introduction of the page to state clearly the goals of LLVM's libc project. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D127174
2022-06-07 06:52:02 +00:00
- Fully compliant with current C standards (C17 and upcoming C2x) and POSIX.
- Easily decomposed and embedded: Supplement or replace system C library
functionality easily. This is useful to get consistent math precision across
systems, or updated memory operations for newer microarchitectures. These
pieces will work on Linux, MacOS, Windows, and Fuchsia.
- The creation of fully static binaries without license implications.
- Increase whole program optimization opportunities for static binaries through
ability to inline math and memory operations.
- Reduce coding errors by coding in modern C++ through the use of lightweight
containers during coding that can be optimized away at runtime.
- Permit fuzzing and sanitizer instrumentation of user binaries including the
libc functions.
- A complete testsuite that tests both the public interface and internal
algorithms.
Rewrite much of the index page for libc The prior page was the proposal doc, this one is now more about what the project intends to do, written in the present tense. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D119379
2022-02-16 03:45:57 +00:00
- `Fuzzing`__
.. __: https://github.com/llvm/llvm-project/tree/main/libc/fuzzing
Add a proposal for a libc project under the LLVM umbrella. Reviewers: chandlerc, dlj, echristo, hfinkel, jfb, zturner Subscribers: dexonsmith, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64939 llvm-svn: 369012
2019-08-15 15:50:42 +00:00
Platform Support
================
Rewrite much of the index page for libc The prior page was the proposal doc, this one is now more about what the project intends to do, written in the present tense. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D119379
2022-02-16 03:45:57 +00:00
Most development is currently targeting x86_64 and aarch64 on Linux. Several
[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
functions in the libc have been tested on Windows. The Fuchsia platform is
slowly replacing functions from its bundled libc with functions from this
project.
Add a proposal for a libc project under the LLVM umbrella. Reviewers: chandlerc, dlj, echristo, hfinkel, jfb, zturner Subscribers: dexonsmith, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64939 llvm-svn: 369012
2019-08-15 15:50:42 +00:00
ABI Compatibility
=================
[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
The libc is written to be ABI independent. Interfaces are generated using
Rewrite much of the index page for libc The prior page was the proposal doc, this one is now more about what the project intends to do, written in the present tense. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D119379
2022-02-16 03:45:57 +00:00
LLVM's tablegen, so supporting arbitrary ABIs is possible. In it's initial
[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
stages there is no ABI stability in any form.
.. toctree::
:hidden:
[libc] Add document for a recipe to do a full standalone cross-build. Reviewed By: jeffbailey Differential Revision: https://reviews.llvm.org/D141037
2023-01-05 01:09:28 -08:00
:maxdepth: 2
[libc] Website fixes (sidebar and mobile) Add "using" and "status" sections to the sidebar to make getting these easier. Fixed mobile formatting not overflow left and right. Tested: Chrome on Desktop, using mobile restrictions in devtools. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131369
2022-08-06 05:30:08 +00:00
:caption: Using
[libc] Add a doc about the libc overlay mode. Reviewed By: jeffbailey Differential Revision: https://reviews.llvm.org/D136810
2022-10-26 17:22:20 -07:00
usage_modes
overlay_mode
fullbuild_mode
[libc][Docs] Begin improving documentation for the GPU libc This patch updates some of the documentation for the GPU libc project. There is a lot of work still to be done, but this sets the general outline. Reviewed By: jdoerfert Differential Revision: https://reviews.llvm.org/D149194
2023-04-25 16:23:07 -05:00
gpu/index.rst
[libc] Website fixes (sidebar and mobile) Add "using" and "status" sections to the sidebar to make getting these easier. Fixed mobile formatting not overflow left and right. Tested: Chrome on Desktop, using mobile restrictions in devtools. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131369
2022-08-06 05:30:08 +00:00
.. toctree::
:hidden:
:maxdepth: 1
:caption: Status
[libc][docs] Move the link to "Compiler Support" under "Status". Also, fixed a minor typo in compiler_support.rst. Reviewed By: jeffbailey, gchatelet Differential Revision: https://reviews.llvm.org/D146112
2023-03-14 22:52:53 -07:00
compiler_support
[libc] Document which date funcs are needed/done Reviewed By: rtenneti Differential Revision: https://reviews.llvm.org/D135501
2022-10-08 00:03:47 +00:00
date_and_time
[libc][doc] Move docs/math.rst to docs/math/index.rst Move docs/math.rst to docs/math/index.rst Reviewed By: michaelrj Differential Revision: https://reviews.llvm.org/D144028
2023-02-14 12:36:07 -05:00
math/index.rst
[libc] Website fixes (sidebar and mobile) Add "using" and "status" sections to the sidebar to make getting these easier. Fixed mobile formatting not overflow left and right. Tested: Chrome on Desktop, using mobile restrictions in devtools. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131369
2022-08-06 05:30:08 +00:00
strings
stdio
.. toctree::
:hidden:
:maxdepth: 1
:caption: Development
Add a proposal for a libc project under the LLVM umbrella. Reviewers: chandlerc, dlj, echristo, hfinkel, jfb, zturner Subscribers: dexonsmith, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64939 llvm-svn: 369012
2019-08-15 15:50:42 +00:00
[libc][docs] Add a build and test document.
2022-11-05 00:58:16 -07:00
build_and_test
[libc][NFC] Move all developer docs into a sub-directory docs/dev.
2023-03-02 10:58:04 -08:00
dev/index.rst
[libc] Add a porting guide to the docs. Reviewed By: jeffbailey Differential Revision: https://reviews.llvm.org/D136960
2022-10-28 00:12:08 -07:00
porting
[libc] Add a contributing guide to the docs. Reviewed By: jeffbailey Differential Revision: https://reviews.llvm.org/D136961
2022-10-28 01:09:38 -07:00
contributing
Move LLVM Proposal to doc directory, create index The LLVM Libc project is no longer just a proposal and should have a webpage tracking the status of the project. This changes puts the pieces into the right place so that the webpage can be created. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D117436
2022-01-29 00:27:34 +00:00
.. toctree::
[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
:hidden:
:maxdepth: 1
:caption: External Links
Move LLVM Proposal to doc directory, create index The LLVM Libc project is no longer just a proposal and should have a webpage tracking the status of the project. This changes puts the pieces into the right place so that the webpage can be created. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D117436
2022-01-29 00:27:34 +00:00
[libc] Update look and feel of libc.llvm.org This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 06:24:43 +00:00
Source Code <https://github.com/llvm/llvm-project/tree/main/libc>
[libc] Website fixes (sidebar and mobile) Add "using" and "status" sections to the sidebar to make getting these easier. Fixed mobile formatting not overflow left and right. Tested: Chrome on Desktop, using mobile restrictions in devtools. Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131369
2022-08-06 05:30:08 +00:00
Bug Reports <https://github.com/llvm/llvm-project/labels/libc>
[libc] Add links to libc Discourse and to the libc Discord channel. Reviewed By: jeffbailey Differential Revision: https://reviews.llvm.org/D137229
2022-11-02 00:34:11 -07:00
Discourse <https://discourse.llvm.org/c/runtimes/libc>
[libc][docs] add link to join the discord Previously we only linked to the channel within the discord. Differential Revision: https://reviews.llvm.org/D145283
2023-03-03 16:06:29 -08:00
Join the Discord <https://discord.gg/xS7Z362>
[libc] Add links to libc Discourse and to the libc Discord channel. Reviewed By: jeffbailey Differential Revision: https://reviews.llvm.org/D137229
2022-11-02 00:34:11 -07:00
Discord Channel <https://discord.com/channels/636084430946959380/636732994891284500>
[libc] Add Buildbot to External Links Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D133186
2022-09-02 06:44:08 +00:00
Buildbot <https://lab.llvm.org/buildbot/#/builders?tags=libc>
Reference in New Issue Copy Permalink