llvm-6502

mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-11-04 06:09:05 +00:00

History

Dmitri Gribenko b8f2d82403 Document current Doxygen use practices in Coding Standards. Mostly it is obvious stuff and most new code being committed conforms to that. Some old code does not; this might cause confusion and this is the motivation to document the correct guidelines. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@166378 91177308-0d34-0410-b5e6-96231b3b80d8		2012-10-20 13:27:43 +00:00
..
_static
_templates
_themes/llvm-theme	Sphinx CSS: remove negative letter-spacing, it makes some fonts look really	2012-09-30 20:43:24 +00:00
CommandGuide	lit: Rename the valgrind leaks feature to match what is currently used	2012-10-19 20:29:30 +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
BitCodeFormat.rst	Fix a typo in bitcode docs, from 165814.	2012-10-15 16:47:58 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
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	Document current Doxygen use practices in Coding Standards. Mostly it is	2012-10-20 13:27:43 +00:00
CommandLine.rst
CompilerWriterInfo.rst	Sphinxify the compiler writer info documentation.	2012-10-07 04:34:10 +00:00
conf.py
DebuggingJITedCode.rst	Fix Sphinx warnings.	2012-09-20 03:20:53 +00:00
design_and_overview.rst
DeveloperPolicy.rst	docs: Minor clean up of Phabricator documentation.	2012-10-12 01:21:24 +00:00
development_process.rst
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst	docs: Propagate fix from r165632 to other docs.	2012-10-10 17:21:39 +00:00
FAQ.rst
GarbageCollection.html	Move TargetData to DataLayout.	2012-10-08 16:39:34 +00:00
GCCFEBuildInstrs.html
GetElementPtr.rst
GettingStarted.rst	GettingStarted.rst: s/&/&/g	2012-10-11 01:10:37 +00:00
GettingStartedVS.rst
GoldPlugin.rst	GoldPlugin.rst: minor typesetting fixes.	2012-10-05 20:50:05 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst	Fix more crlf issues.	2012-09-27 22:14:10 +00:00
HowToReleaseLLVM.html
HowToSetUpLLVMStyleRTTI.rst	docs: Update example to conform to coding standards.	2012-10-12 01:55:51 +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	Update the LangRef documentation for the per pointer address space support.	2012-10-18 18:18:17 +00:00
Lexicon.rst	Documentation: Lexicon.rst: add "BB Vectorization" and "TBAA".	2012-10-13 17:34:49 +00:00
LinkTimeOptimization.rst	docs: Sphinxify GoldPlugin document.	2012-10-04 03:56:23 +00:00
LLVMBuild.html
LLVMBuild.txt
mailing_lists.rst
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
Packaging.rst
Passes.html
Phabricator.rst	docs: Minor clean up of Phabricator documentation.	2012-10-12 01:21:24 +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
re_format.7
README.txt	test commit: verifying access from new address	2012-10-18 18:12:05 +00:00
ReleaseNotes.html	Vectorization docs.	2012-10-20 02:34:34 +00:00
SegmentedStacks.rst
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: Add link to integrated assembler HowTo	2012-10-17 16:36:27 +00:00
SystemLibrary.html
TableGenFundamentals.rst
TestingGuide.html	Fix some doc-os.	2012-10-19 17:23:39 +00:00
TestSuiteMakefileGuide.html
userguides.rst	docs: Minor clean up of Phabricator documentation.	2012-10-12 01:21:24 +00:00
WritingAnLLVMBackend.html	Move TargetData to DataLayout.	2012-10-08 16:39:34 +00:00
WritingAnLLVMPass.html
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.