llvm/docs at 5665a3dbc909c1450ac17e311977cbaf9025525b - llvm

RPCS3/llvm

mirror of https://github.com/RPCS3/llvm.git synced 2025-01-19 08:24:12 +00:00

History

Sean Silva 5d499c2de4 docs: Add SphinxQuickstartTemplate.rst.

The intent of this document is to be the go-to document for anybody who
wants to write new documentation, but isn't familiar with Sphinx.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165775 91177308-0d34-0410-b5e6-96231b3b80d8

2012-10-12 00:53:48 +00:00

_static

[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.

2012-04-19 20:20:34 +00:00

_templates

[docs] Convert docs index page into Sphinx.

2012-04-19 16:31:37 +00:00

_themes/llvm-theme

Sphinx CSS: remove negative letter-spacing, it makes some fonts look really

2012-09-30 20:43:24 +00:00

CommandGuide

Remove references to compression in llvm-ar. It has been a long time since we

2012-08-10 01:57:52 +00:00

HistoricalNotes

…

tutorial

Move TargetData to DataLayout.

2012-10-08 16:39:34 +00:00

AliasAnalysis.rst

RST docs: convert HTML escapes to plain text in code examples.

2012-09-30 20:51:02 +00:00

Atomics.rst

Fix a typo (the the => the)

2012-07-23 08:51:15 +00:00

BitCodeFormat.rst

Sphinxify the bitcode format document.

2012-06-28 08:43:12 +00:00

BranchWeightMetadata.rst

Sphinxify BranchWeightMetadata document.

2012-06-20 10:17:46 +00:00

Bugpoint.rst

Sphyinxify the Bugpoint document.

2012-06-26 11:37:00 +00:00

CMake.rst

Removing dependency on third party library for Intel JIT event support.

2012-09-28 17:35:20 +00:00

CodeGenerator.rst

Move TargetData to DataLayout.

2012-10-08 16:39:34 +00:00

CodingStandards.rst

[Docs] Update File Headers section to cover doxygen style file level docs.

2012-10-01 19:59:21 +00:00

CommandLine.rst

Sphinxify the CommandLine document.

2012-08-08 08:21:24 +00:00

CompilerWriterInfo.rst

Sphinxify the compiler writer info documentation.

2012-10-07 04:34:10 +00:00

conf.py

[Docs] Fix Sphinx incremental build. Patch by Sean Silva!

2012-09-05 19:44:47 +00:00

DebuggingJITedCode.rst

Fix Sphinx warnings.

2012-09-20 03:20:53 +00:00

design_and_overview.rst

Sphixify the GEP FAQ.

2012-06-20 21:54:22 +00:00

DeveloperPolicy.rst

Adds Phabricator documentation. This is a first step that answers many questions we have seen.

2012-10-11 19:40:46 +00:00

development_process.rst

Move coding standards reference from development_process.rst to programming.rst.

2012-06-20 11:56:24 +00:00

doxygen.cfg.in

…

doxygen.css

[docs] Update Makefile for images removal.

2012-04-20 17:27:12 +00:00

doxygen.footer

…

doxygen.header

…

doxygen.intro

…

ExceptionHandling.rst

Sphinxify the exception handling doc.

2012-06-27 07:20:57 +00:00

ExtendedIntegerResults.txt

…

ExtendingLLVM.rst

docs: Propagate fix from r165632 to other docs.

2012-10-10 17:21:39 +00:00

FAQ.rst

[docs] Port FAQ over to Sphinx.

2012-06-18 20:21:38 +00:00

GarbageCollection.html

Move TargetData to DataLayout.

2012-10-08 16:39:34 +00:00

GCCFEBuildInstrs.html

[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.

2012-04-19 20:20:34 +00:00

GetElementPtr.rst

Sphixify the GEP FAQ.

2012-06-20 21:54:22 +00:00

GettingStarted.rst

GettingStarted.rst: s/&/&/g

2012-10-11 01:10:37 +00:00

GettingStartedVS.rst

Fix a typo (the the => the)

2012-07-23 08:51:15 +00:00

GoldPlugin.rst

GoldPlugin.rst: minor typesetting fixes.

2012-10-05 20:50:05 +00:00

HowToAddABuilder.rst

Patch by Sean Silva!

2012-09-13 23:51:08 +00:00

HowToBuildOnARM.rst

Fix more crlf issues.

2012-09-27 22:14:10 +00:00

HowToReleaseLLVM.html

Fix some minor typos

2012-07-31 07:05:57 +00:00

HowToSetUpLLVMStyleRTTI.rst

docs: Improve HowToSetUpLLVMStyleRTTI.

2012-10-11 23:30:52 +00:00

HowToSubmitABug.rst

docs: Sphinxify HowToSubmitABug

2012-09-25 20:52:04 +00:00

index.rst

docs: Fix typo on front page

2012-10-04 04:41:27 +00:00

LangRef.html

Move TargetData to DataLayout.

2012-10-08 16:39:34 +00:00

Lexicon.rst

Sphinxify the lexicon doc.

2012-06-20 10:36:41 +00:00

LinkTimeOptimization.rst

docs: Sphinxify GoldPlugin document.

2012-10-04 03:56:23 +00:00

LLVMBuild.html

llvm-build: Add support for non-installed libraries (e.g., gtest).

2012-05-15 18:44:17 +00:00

LLVMBuild.txt

…

mailing_lists.rst

[docs] Convert docs index page into Sphinx.

2012-04-19 16:31:37 +00:00

make.bat

[docs] Stub out structure for Sphinx-based docs.

2012-04-19 16:31:19 +00:00

Makefile

[docs] Remove POD based man page docs (and build system support).

2012-05-08 17:48:21 +00:00

Makefile.sphinx

[Docs] Fix Sphinx incremental build. Patch by Sean Silva!

2012-09-05 19:44:47 +00:00

MakefileGuide.rst

Sphinxify the MakefileGuide document.

2012-06-20 04:20:39 +00:00

Packaging.rst

Sphinxify the outdated Packaging documentation.

2012-06-21 06:09:37 +00:00

Passes.html

Fix two typos in the doc

2012-07-25 22:01:31 +00:00

Phabricator.rst

Adds Phabricator documentation. This is a first step that answers many questions we have seen.

2012-10-11 19:40:46 +00:00

ProgrammersManual.html

Document MapVector.

2012-10-07 00:56:09 +00:00

programming.rst

Sphinxify the ExtendingLLVM documentation.

2012-10-07 04:56:08 +00:00

Projects.rst

Fix grammar-o. Fixes PR13482!

2012-07-30 21:10:51 +00:00

re_format.7

…

README.txt

[docs] Stub out structure for Sphinx-based docs.

2012-04-19 16:31:19 +00:00

ReleaseNotes.html

Add a new optimization pass: Stack Coloring, that merges disjoint static allocations (allocas). Allocas are known to be

2012-09-06 09:17:37 +00:00

SegmentedStacks.rst

Sphinxify the SegmentedStack document.

2012-06-20 12:05:05 +00:00

SourceLevelDebugging.html

Fix typo in docs.

2012-10-08 23:54:10 +00:00

SphinxQuickstartTemplate.rst

docs: Add SphinxQuickstartTemplate.rst.

2012-10-12 00:53:48 +00:00

subsystems.rst

docs: Sphinxify GoldPlugin document.

2012-10-04 03:56:23 +00:00

SystemLibrary.html

[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.

2012-04-19 20:20:34 +00:00

TableGenFundamentals.rst

Cleanup some encoding mishaps.

2012-06-21 07:01:02 +00:00

TestingGuide.html

Revert r156393, "[tests] Remove some remaining DejaGNU related cruft.", this

2012-05-08 18:26:07 +00:00

TestSuiteMakefileGuide.html

Fix some minor typos

2012-07-31 07:05:57 +00:00

userguides.rst

docs: Add SphinxQuickstartTemplate.rst.

2012-10-12 00:53:48 +00:00

WritingAnLLVMBackend.html

Move TargetData to DataLayout.

2012-10-08 16:39:34 +00:00

WritingAnLLVMPass.html

[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.

2012-04-19 20:20:34 +00:00

yaml2obj.rst

docs: Fix long-standing typo in yaml2obj.rst.

2012-09-21 19:48:16 +00:00

README.txt

LLVM Documentation
==================

The LLVM documentation is currently written in two formats:

  * Plain HTML documentation.

  * reStructured Text documentation using the Sphinx documentation generator. It
    is currently tested with Sphinx 1.1.3.

    For more information, see the "Sphinx Introduction for LLVM Developers"
    document.