mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2025-02-21 21:29:41 +00:00
4a535629ec
This change also removes a bunch of boilerplate and stuffing which made it unnecessarily hard to navigate and see the comparatively miniscule actual content that was added to this document during the 3.2 development period (or maybe even sticking around from earlier releases...). The new organization (a flat list) optimizes for making it easy for people who know about changes to add them to the document. It's completely trivial for anyone with basic knowledge of LLVM to come in later (such as when preparing for the actual release) and cluster any changes into logical groups. However, I have left some comments indicating how to add larger descriptions, if someone is feeling adventurous ;) Hopefully this organization will highlight how little effort is being put into producing accurate, high-quality release notes, prompting a corresponding improvement for the 3.3 release. I have preserved the changes to this document that are not present in the 3.2 release notes. There were only two... I'm pretty sure we've been busier than that... (version control shows +213347/-173656 raw lines just in the LLVM repo since the 3.2 release). git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172954 91177308-0d34-0410-b5e6-96231b3b80d8
LLVM Documentation
==================
LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is meant to be processed by the Sphinx documentation generation system to
create HTML pages which are hosted on <http://llvm.org/docs/> and updated
after every commit.
If you instead would like to generate and view the HTML locally, install
Sphinx <http://sphinx-doc.org/> and then do:
cd docs/
make -f Makefile.sphinx
$BROWSER _build/html/index.html
The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
If you are interested in writing new documentation, you will want to read
`SphinxQuickstartTemplate.rst` which will get you writing documentation
very fast and includes examples of the most important reStructuredText
markup syntax.