RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-23 19:23:23 +01:00
Code Issues Projects Releases Wiki Activity
9ecefd6948
llvm-mirror/docs
History
Sean Silva 9ecefd6948 docs: Attempt to fix PR14053. 
Hypothesis 1: use of `.. code::` directive instead of `.. code-block::`
is causing Sphinx to discard the block. On my machine, `.. code::`
renders fine. However, I don't think that `..  code::` is actually a
legit Sphinx directive. I believe that on my machine Sphinx is falling
back to just displaying it monospace with no syntax, whereas llvm.org's
Sphinx is just discarding it.

This is truly "remote debugging" since I can't reproduce this on my
machine. It would be helpful to be able to see the llvm.org Sphinx
build logs; if that's possible please let me know.

llvm-svn: 165632
2012-10-10 17:07:23 +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 Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
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 Test commit 2012-09-18 22:21:43 +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 Reapply r141657. 2011-10-31 23:46:50 +00:00
doxygen.css [docs] Update Makefile for images removal. 2012-04-20 17:27:12 +00:00
doxygen.footer Happy new year 2012! 2012-01-01 08:16:56 +00:00
doxygen.header Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
doxygen.intro Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
ExceptionHandling.rst Sphinxify the exception handling doc. 2012-06-27 07:20:57 +00:00
ExtendedIntegerResults.txt Revert r103213. It broke several sections of live website. 2010-05-07 00:28:04 +00:00
ExtendingLLVM.rst Sphinxify the ExtendingLLVM documentation. 2012-10-07 04:56:08 +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 docs: Attempt to fix PR14053. 2012-10-10 17:07:23 +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 HowToSetUpLLVMStyleRTTI.rst: remove unneeded semicolons in code examples. 2012-10-05 20:52:13 +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 LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
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
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 Revert r103213. It broke several sections of live website. 2010-05-07 00:28:04 +00:00
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
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 Sphinxify the GettinStarted documentation. 2012-10-07 07:10:13 +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.