Commit Graph

4646 Commits

Author SHA1 Message Date
Dmitri Gribenko
e17d858da8 Documentation: convert ReleaseNotes.html to reST.
Patch by Anthony Mykhailenko with small fixes by me.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169714 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09 23:14:26 +00:00
Chris Lattner
d8fdf5d379 So many people have touched this, it doesn't make sense to ascribe authorship anymore.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169704 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09 16:55:39 +00:00
Sean Silva
691f470d47 docs: Convert GarbageCollection.html to reST
Patch by Alexander Zinenko!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169702 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09 15:52:47 +00:00
Dmitri Gribenko
6297bfa80e Documentation: HowToReleaseLLVM.rst: remove trailing whitespace.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169700 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09 15:33:26 +00:00
Dmitri Gribenko
76d182f7c2 Documentation: don't create TOCs manually.
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-09 15:29:56 +00:00
John Criswell
288bf1cab0 Fixed some grammar and punctuation error.
No content changes.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169627 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-07 19:21:10 +00:00
Dmitri Gribenko
69c0239a26 Convert HowToReleaseLLVM.html to reST
Patch by Alexander Zinenko.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169608 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-07 16:42:48 +00:00
Sean Silva
f722b007b2 docs: Convert LangRef to reST.
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-07 10:36:55 +00:00
Dmitri Gribenko
b553f8960a Documentation: fix typos and formatting.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169546 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-06 21:12:35 +00:00
Sean Silva
b63ae85382 docs: Explain plain preformatted text
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169352 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-05 04:07:33 +00:00
Sean Silva
ee47edfd8e docs: Sphinxify docs/tutorial/
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-05 00:26:32 +00:00
Sean Silva
91b9763d53 docs: Begin Sphinxification of docs/tutorial/
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169309 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04 21:16:41 +00:00
Sean Silva
1693583fe2 docs: fixup legacy HTML link
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169308 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04 21:16:34 +00:00
Justin Holewinski
315f09f422 Update release notes for NVPTX
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169280 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04 16:11:51 +00:00
Eli Bendersky
2cbe23fd98 Get rid of references to Tcl, DejagGNU, old test structure, discourage the use
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-04 14:34:00 +00:00
Eli Bendersky
8b0eab4fb4 Remove the very out-of-date listing of "very important LLVM areas". I don't
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-04 13:55:17 +00:00
Sean Silva
821c0e4ccf docs: Fix broken link.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169211 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04 03:45:27 +00:00
Sean Silva
1bc2bab332 docs: Fix dead link.
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-04 03:30:36 +00:00
Sean Silva
b715b205a4 docs: Convert ProgrammersManual to reST.
Patch by Alexander Zinenko!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169208 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04 03:20:08 +00:00
Eli Bendersky
56537a5886 Clean up, bring up-to-date and apply consistent formatting.
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-03 04:10:58 +00:00
Chandler Carruth
afcc374524 Simplify the coding standards for #include ordering. The ordering is now
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-02 11:53:27 +00:00
Justin Holewinski
19b3f3d985 Unbreak Sphinx build
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169106 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-02 02:47:48 +00:00
Eli Bendersky
1f90eb4674 Another fix attempt to Makefile.sphinx - copy the PNGs from tutorial/ as well,
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-01 22:21:04 +00:00
Eli Bendersky
c7ff36a863 Attempt to fix Makefile.sphinx to not generate errors while trying to copy
files from tutorial/.svn


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169104 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01 22:11:59 +00:00
Eli Bendersky
ed04fd2053 Update FileCheck's documentation to mention recently added feature of
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-01 22:03:57 +00:00
Dmitri Gribenko
91cb694fd7 Documentation: convert WritingAnLLVMBackend.html to reST
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169087 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01 12:13:48 +00:00
Michael Ilseman
5ba39ae563 Removed redundancy in wording
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169053 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-30 23:14:52 +00:00
Michael Ilseman
01b3710eae Clean up the documentation to have a common description area for fast-math flags.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169052 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-30 23:12:42 +00:00
Dmitri Gribenko
c8c3dbd911 Documentation for FileCheck: use 'option' and 'program' directives.
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-29 19:21:02 +00:00
Dmitri Gribenko
f2c87b1c05 Documentation for llvm-link: reformat
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168924 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 19:14:35 +00:00
Dmitri Gribenko
90d0e7e8be Documentation for llvm-cov: reformat
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168922 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 19:10:21 +00:00
Dmitri Gribenko
b36be80510 Documentation for llvm-stress: reformat
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168920 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 19:05:55 +00:00
Dmitri Gribenko
f03b5e947b Documentation for opt: reformat
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168919 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 19:02:50 +00:00
Dmitri Gribenko
dff966c9d8 Documentation for llc: reformat.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168912 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 18:16:11 +00:00
Dmitri Gribenko
bc5fb06785 Documentation for lit: more formatting: use 'option' and 'program' directives.
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-29 18:03:08 +00:00
Dmitri Gribenko
6a144e40b0 Documentation for tblgen: formatting
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168904 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 17:41:05 +00:00
Dmitri Gribenko
e26b62cb61 Documentation for lit: formatting improvements.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168902 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 17:05:34 +00:00
Dmitri Gribenko
b129b9b617 Documentation: formatting improvements
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168897 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 16:12:13 +00:00
Dmitri Gribenko
6bb2b5d76e Documentation: use correct highlighter
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168871 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 12:00:32 +00:00
Dmitri Gribenko
0215368887 Documentation: improve formatting and remove unneeded empty lines.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168817 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-28 21:40:54 +00:00
Eli Bendersky
00a3e5e724 Some grammar fixes
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168752 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-28 00:27:25 +00:00
NAKAMURA Takumi
51434aa375 docs: [CMake] Add Xcode to the list of project formats CMake can generate.
Suggested by Sean McBride, thanks!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168745 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-27 23:34:28 +00:00
Michael Ilseman
a33e3d75fe Fast-math flags documentation added to LangRef
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168652 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-27 00:48:29 +00:00
Bill Wendling
8a66b6ab45 Correct copy-pasto where we're talking about function attributes and not parameter attributes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168619 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-26 22:04:13 +00:00
Dmitri Gribenko
bbef5ead4c Documentation: convert SourceLevelDebugging.html to reST
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168493 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-22 11:56:02 +00:00
Chandler Carruth
7a3b7e5efc Remove 'sretpromotion' pass from the documentation. This pass is long
dead.

Patch by Stephan Falke.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168492 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-22 11:17:08 +00:00
Eli Bendersky
17ced4521f Fix a typo in FileCheck.rst
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168466 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-21 22:40:52 +00:00
Eli Bendersky
099bfe68a4 Some sphinx-ing and consistency fixes
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168380 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20 19:37:58 +00:00
Joe Abbey
2db2749c67 Better 80cols... *sigh*
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168373 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20 18:14:15 +00:00
Joe Abbey
8162cf4567 Fixing a broken link.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168372 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-20 17:51:08 +00:00