aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2012-12-09So many people have touched this, it doesn't make sense to ascribe ↵Chris Lattner
authorship anymore. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169704 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09docs: Convert GarbageCollection.html to reSTSean Silva
Patch by Alexander Zinenko! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169702 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09Documentation: HowToReleaseLLVM.rst: remove trailing whitespace.Dmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169700 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09Documentation: don't create TOCs manually.Dmitri Gribenko
Thanks to Sean Silva for pointing out! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169699 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-07Fixed some grammar and punctuation error.John Criswell
No content changes. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169627 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-07Convert HowToReleaseLLVM.html to reSTDmitri Gribenko
Patch by Alexander Zinenko. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169608 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-07docs: Convert LangRef to reST.Sean Silva
NOTE: If you have any patches in the works that modify LangRef, you will need to rewrite the changes to LangRef.html to their equivalents in LangRef.rst. If you need assistance feel free to contact me. Since LangRef is mission-critical for the project and "normative", I have taken extra care to ensure that no content was lost or altered in the conversion. The content was converted with a tool called `pandoc`, so there is no chance for a human error like accidentally forgetting a sentence or whatever. After the initial conversion by `pandoc`, only changes to the markup were done. This is just the most literal conversion of the HTML document as possible. It might be worth exploring some way to chop up this massive document into separate pages, e.g. something like `docs/LangRef/Instructions.rst`, `docs/LangRef/Intrinsics.rst`, etc. with `docs/LangRef.rst` being an "intro/navigation page" of sorts. On the other hand, that loses the ability to {Ctrl,Cmd}-F for a given term right from your browser. IMO, I think our stylesheet needs some work because I find it hard to tell what level of nesting some of the headings are at (e.g. "is this a new section or is it a subsection?"). The issue is present on other pages, but the sheer size and deep section structure of LangRef really brings this issue out. If there are any web designers out there in the community it would be awesome if you tried to come up with something nicer. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169596 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-06Documentation: fix typos and formatting.Dmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169546 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-05docs: Explain plain preformatted textSean Silva
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169352 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-05docs: Sphinxify `docs/tutorial/`Sean Silva
Sorry for the massive commit, but I just wanted to knock this one down and it is really straightforward. There are still a couple trivial (i.e. not related to the content) things left to fix: - Use of raw HTML links where :doc:`...` and :ref:`...` could be used instead. If you are a newbie and want to help fix this it would make for some good bite-sized patches; more experienced developers should be focusing on adding new content (to this tutorial or elsewhere, but please _do not_ waste your time on formatting when there is such dire need for documentation (see docs/SphinxQuickstartTemplate.rst to get started writing)). - Highlighting of the kaleidoscope code blocks (currently left as bare `::`). I will be working on writing a custom Pygments highlighter for this, mostly as training for maintaining the `llvm` code-block's lexer in-tree. I want to do this because I am extremely unhappy with how it just "gives up" on the slightest deviation from the expected syntax and leaves the whole code-block un-highlighted. More generally I am looking at writing some Sphinx extensions and keeping them in-tree as well, to support common use cases that currently have no good solution (like "monospace text inside a link"). git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169343 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04docs: Begin Sphinxification of docs/tutorial/Sean Silva
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169309 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04docs: fixup legacy HTML linkSean Silva
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169308 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04Update release notes for NVPTXJustin Holewinski
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169280 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04Get rid of references to Tcl, DejagGNU, old test structure, discourage the useEli Bendersky
of grep in favor of FileCheck, and other cleanups. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169269 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04Remove the very out-of-date listing of "very important LLVM areas". I don'tEli Bendersky
think it adds much and keeping it up-to-date is (obviously) a chore. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169263 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04docs: Fix broken link.Sean Silva
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169211 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04docs: Fix dead link.Sean Silva
Apparently Dinkumware are no longer hosting their nice reference manuals. Thankfully, `cppreference.com` can fill that role well. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169210 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04docs: Convert ProgrammersManual to reST.Sean Silva
Patch by Alexander Zinenko! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169208 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-03Clean up, bring up-to-date and apply consistent formatting.Eli Bendersky
This document is a long-time pet peeve :-) More fixes to come. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169115 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-02Simplify the coding standards for #include ordering. The ordering is nowChandler Carruth
trivially achievable with an editor. I'll likely check in a silly python script to help with this too. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169107 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-02Unbreak Sphinx buildJustin Holewinski
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169106 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01Another fix attempt to Makefile.sphinx - copy the PNGs from tutorial/ as well,Eli Bendersky
and recursive copying is not required for the tutorial/ directory. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169105 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01Attempt to fix Makefile.sphinx to not generate errors while trying to copyEli Bendersky
files from tutorial/.svn git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169104 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01Update FileCheck's documentation to mention recently added feature ofEli Bendersky
matching a variable defined on the same line. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169103 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01Documentation: convert WritingAnLLVMBackend.html to reSTDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169087 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-30Removed redundancy in wordingMichael Ilseman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169053 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-30Clean up the documentation to have a common description area for fast-math ↵Michael Ilseman
flags. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169052 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for FileCheck: use 'option' and 'program' directives.Dmitri Gribenko
This enables option cross-referencing and now '--' in option names are no more turned into en dashes. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168926 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for llvm-link: reformatDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168924 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for llvm-cov: reformatDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168922 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for llvm-stress: reformatDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168920 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for opt: reformatDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168919 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for llc: reformat.Dmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168912 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for lit: more formatting: use 'option' and 'program' directives.Dmitri Gribenko
This enables cross-referencing and now '--' in option names are no more turned into en dashes. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168906 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for tblgen: formattingDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168904 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation for lit: formatting improvements.Dmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168902 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation: formatting improvementsDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168897 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29Documentation: use correct highlighterDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168871 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-28Documentation: improve formatting and remove unneeded empty lines.Dmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168817 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-28Some grammar fixesEli Bendersky
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168752 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-27docs: [CMake] Add Xcode to the list of project formats CMake can generate.NAKAMURA Takumi
Suggested by Sean McBride, thanks! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168745 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-27Fast-math flags documentation added to LangRefMichael Ilseman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168652 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-26Correct copy-pasto where we're talking about function attributes and not ↵Bill Wendling
parameter attributes. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168619 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-22Documentation: convert SourceLevelDebugging.html to reSTDmitri Gribenko
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168493 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-22Remove 'sretpromotion' pass from the documentation. This pass is longChandler Carruth
dead. Patch by Stephan Falke. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168492 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-21Fix a typo in FileCheck.rstEli Bendersky
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168466 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20Some sphinx-ing and consistency fixesEli Bendersky
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168380 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20Better 80cols... *sigh*Joe Abbey
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168373 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20Fixing a broken link.Joe Abbey
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168372 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20docs: Fix highlighting.Sean Silva
.git/config was marked as "bash" instead of "ini". git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168365 91177308-0d34-0410-b5e6-96231b3b80d8