Files
RedBear-OS/local/recipes/dev/libclc/source/llvm/docs/index.rst
T
vasilito cb424d7448 build: static patch-sanity linter (shift-left the malformed-patch class)
verify-patch-sanity.py validates every active recipe .patch has internally-
consistent hunk line counts — catching the 'malformed patch at line N' failure
at commit/CI/preflight time instead of hours into a cook. This cycle hit that
class three times (qtwaylandscanner, sddm, xwayland), each only discovered when
cookbook tried to apply the patch.

Running it across the repo found 29 latent malformed patches (validated against
GNU patch: e.g. relibc/P3-sysv-ipc reproduces 'malformed patch at line 22').
They were harmless only because they sit in vendored recipes (baked, not re-
applied) — but would fail on any version-bump re-derivation. --fix recounts the
hunk headers (body untouched) and repaired all 29.

Wired into build-preflight.sh (Phase 1.0D) and redbear-ci.yml, with a unit test
(test-patch-sanity.sh). Skips archived/legacy trees and unvalidatable formats
(empty placeholders, bare-@@ git hunks).
2026-08-01 05:13:02 +03:00

108 lines
2.2 KiB
ReStructuredText

About
========
.. warning::
If you are using a released version of LLVM, see `the download page
<https://llvm.org/releases/>`_ 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.
.. toctree::
:hidden:
FAQ
Lexicon
:doc:`FAQ`
Frequently asked questions.
:doc:`Lexicon`
Glossary.
`Introduction to the LLVM Compiler`__
Presentation providing a users introduction to LLVM.
.. __: https://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
`Intro to LLVM`__
A chapter from the book "The Architecture of Open Source Applications" that
describes high-level design decisions that shaped LLVM.
.. __: http://www.aosabook.org/en/llvm.html
`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Design overview.
.. __: https://llvm.org/pubs/2004-01-30-CGO-LLVM.html
`LLVM: An Infrastructure for Multi-Stage Optimization`__
More details (quite old now).
.. __: https://llvm.org/pubs/2002-12-LattnerMSThesis.html
Documentation
=============
Getting Started, How-tos, Developer Guides, and Tutorials.
.. toctree::
: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:
.. toctree::
:hidden:
GettingInvolved
QualGroup
* :doc:`GettingInvolved`
* :ref:`development-process`
* :ref:`lists-forums`
* :ref:`meetups-social-events`
* :ref:`community-proposals`
Reporting a security issue
* :ref:`report-security-issue`
* :doc:`QualGroup`
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`