Reid Kleckner
3e414a36cd
This was done with LLM assistance. I rebuilt the LLVM docs, opened all 22 docs in a browser and scrolled through them, and caught and fixed a few errors. Tracking issue: #201242 Migration guide docs: https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines RFC: https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/90840
2.2 KiB
2.2 KiB
About
If you are using a released version of LLVM, see [the download page]
to find your documentation.
The LLVM compiler infrastructure supports a wide range of projects, from industrial strength compilers to specialized JIT applications to small research projects.
Similarly, documentation is broken down into several high-level groupings targeted at different audiences:
LLVM Design & Overview
Several introductory papers and presentations.
:hidden:
FAQ
Lexicon
- {doc}
FAQ - Frequently asked questions.
- {doc}
Lexicon - Glossary.
- Introduction to the LLVM Compiler
- Presentation providing a users introduction to LLVM.
- Intro to LLVM
- A chapter from the book "The Architecture of Open Source Applications" that describes high-level design decisions that shaped LLVM.
- LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation
- Design overview.
- LLVM: An Infrastructure for Multi-Stage Optimization
- More details (quite old now).
Documentation
Getting Started, How-tos, Developer Guides, and Tutorials.
:hidden:
GettingStartedTutorials
Reference
UserGuides
DiscourseMigrationGuide
- {doc}
GettingStartedTutorials - For those new to the LLVM system.
- {doc}
UserGuides - User guides and How-tos.
- {doc}
Reference - LLVM and API reference documentation.
- {doc}
DiscourseMigrationGuide - Guide for users to migrate to Discourse
Community
LLVM welcomes contributions of all kinds. To learn more, see the following articles:
:hidden:
GettingInvolved
RFCProcess
ProjectGovernance
-
{doc}
GettingInvolved -
{ref}
development-process -
{doc}
RFCProcess -
{doc}
ProjectGovernance -
{ref}
lists-forums -
{ref}
meetups-social-events -
{ref}
community-proposalsReporting a security issue
-
{ref}
report-security-issue
Indices and tables
- {ref}
genindex - {ref}
search