Commit Graph

44 Commits

Author SHA1 Message Date
Chandler Carruth 4e764b4cb1 [docs] Stop advertising 'make update'. It isn't implemented in CMake and
seems unlikely to be added. It also doesn't seem like it should be part
of the build system at all (consider out-of-tree builds).

We should probably add nice, easy tool for this that works both for svn
client trees and git-svn client trees, but it probably won't be spelled
"make update".

llvm-svn: 202430
2014-02-27 21:19:42 +00:00
Chandler Carruth 55cc48f403 [docs] Actually spell out the new version requirements for the host C++
toolchain of LLVM. These are already being enforced by the build system
and have been discussed quite a few times on the lists, but
documentation is important. =]

Also, garbage collect the majority of the information about broken host
GCC toolchains. These aren't really relevant any more as they're all
older than the minimum requirement. I've left a few notes about
compilers one step older than the current requirement as these compilers
are at least conceivable to use, and it's better to preserve this kind
of hard-won institutional knowledge.

The next step will be some specific docs on how to set up a sufficiently
modern host toolchain if your system doesn't come with one. But that'll
be tomorrow. =]

llvm-svn: 202375
2014-02-27 10:35:57 +00:00
Chandler Carruth 8356ce4121 [docs] Clean up some of the required software to not mention irrelevant
bits of software and to use a modern GCC version.

The Subversion bit was weird anyways -- it has nothing to do with
compiling LLVM. Also, there are many other ways to get at the trunk
source (git, git-svn, etc).

The TeXinfo thing... I have no idea about. But you can get a working
LLVM w/o it pretty easily. If man pages or something are missing, that
hardly seems like a problem. If folks really want this back, let me
know, but it seems mostly like a distraction.

I'd still like to separate this into:
- Required software to compile.
- Optional software to compile.
- Required software for certain *contributor* activities (like
  regenerating configure scripts).

Also we need to mention that there are multiple options for build
systems, and the differences.

Also we should mention Windows.

Also probably other stuff I'm forgetting.

I'm wondering if this whole thing needs to be shot in the head and we
should just start a new, simpler getting started that doesn't have so
many years of accumulated stuff that is no longer relevant.

llvm-svn: 202373
2014-02-27 09:57:48 +00:00
Chandler Carruth e04872dbc3 [docs] Switch this table to the simple form as well. No content changed.
llvm-svn: 202372
2014-02-27 09:46:09 +00:00
Chandler Carruth 4ef7efe771 [docs] Switch to the incredibly simpler "simple table" form. It now
actually looks like the table on the webpage and is entertainingly
smaller, easier to read, and easier to edit.

llvm-svn: 202371
2014-02-27 09:41:13 +00:00
Chandler Carruth 41e1b91750 [docs] Delete tons of bad information in the requirements section of the
getting started guide.

Some highlights:
- I heard there was this Clang compiler that you could use for your
  host compiler. Not sure though.
- We no longer have a GCC frontend with weird build restrictions.
- Windows is doing a bit better than partially supported.
- We nuked everything to do with itanium.
- SPUs? Really?
- Xcode 2.5 and gcc 4.0.1 are really not a concern -- they don't work.
- OMG, we actually tried building LLVM on Alpha? Really?
- PowerPC works pretty well these days.

There is still a lot of stuff here I'm pretty dubious about, but I nuked
most of what was actively misleading, out of date, or patently wrong.
Some of it (mingw stuff especially) isn't really lacking, its just that
the comments here were actively wrong. Hopefully folks that know those
platforms can add back correct / modern information.

llvm-svn: 202370
2014-02-27 09:33:55 +00:00
Dmitri Gribenko 57150d3a22 Add a note to documentation that Clang + libstdc++ 4.7.2 can not be used to build LLD.
llvm-svn: 200758
2014-02-04 12:02:13 +00:00
Bill Wendling 27f96dae10 Update the Python version. And Perl isn't used anymore.
PR17608

llvm-svn: 193491
2013-10-27 04:02:21 +00:00
Bill Wendling a40c5263ed Add missing releases.
llvm-svn: 192304
2013-10-09 17:37:04 +00:00
Renato Golin 22a2d963b9 Add links to cross-compilation docs from getting started
llvm-svn: 191425
2013-09-26 08:57:07 +00:00
Chandler Carruth baf3fdb86b Nuke the hilariously out of date suggestion to unpack llvm-gcc 4.2 as
part of getting started with LLVM.

The LLVM getting started document is in woeful need of attention. I may
get to some of this, but some random notes for folks interested:

1) We need to separate the getting started steps for folks who are
   interested in the core LLVM libs and nothing else, folks interested
   in a nifty C++ toolchain and nothing else, and folks interested in
   both.
2) We should include documentation for both release archives, svn, and
   git in equal portion, and we should document all of the various
   repositories of interest: llvm, clang, clang-tools-extra,
   compiler-rt, lld, libcxx, test-suite.
3) We should document the CMake build. We should probably document the
   CMake build first, and give a fall-back set of docs for the Makefile
   build for the use cases where that is still the preferred solution.
   This would more closely match the use cases that folks in the open
   source community are likely to have, and would remove a point of
   discrepancy between Linux, Windows, and Mac instructions.
4) Probably a ton of other modernization stuff that I've not thought of
   here.

Anyways, if anyone at all is interested, please help clean up this
document. It is much needed.

llvm-svn: 189732
2013-09-01 23:42:27 +00:00
Daniel Dunbar 06b9f9ecaa [typo] An LLVM.
llvm-svn: 188589
2013-08-16 23:30:19 +00:00
Rafael Espindola 729866670b Remove the mblaze backend from llvm.
Approval in here http://lists.cs.uiuc.edu/pipermail/llvmdev/2013-July/064169.html

llvm-svn: 187145
2013-07-25 18:55:05 +00:00
Michael Liao e7fdb1386a Fix documentation on the path to Bitcode reader/writer
llvm-svn: 183761
2013-06-11 18:09:21 +00:00
Rui Ueyama 142736fc64 Fix typo in docs/GettingStarted.rst.
llvm-svn: 182496
2013-05-22 18:09:39 +00:00
Ulrich Weigand 1ceebf6ee0 [SystemZ] Add configure bits
This patch wires up the SystemZ target in configure, so that it can now be
built using --enable-targets=systemz.   It is not yet included in the default
build (--enable-targets=all); this will be done by a follow-up patch.

Patch by Richard Sandiford.

llvm-svn: 181208
2013-05-06 16:22:34 +00:00
Michael Gottesman a0509add5b Updated GettingStarted.rst so that it references utils/git-svn for git-svnup instead of catting it into the documentation itself.
llvm-svn: 180589
2013-04-26 01:04:45 +00:00
Alexey Samsonov 2fb337e77a Add basic zlib support to LLVM. This would allow to use compression/uncompression in selected LLVM tools.
llvm-svn: 180083
2013-04-23 08:28:39 +00:00
Thomas Schwinge b1322d5691 Correct spelling of Git.
llvm-svn: 178254
2013-03-28 18:06:20 +00:00
Dmitri Gribenko 51cb2fa1c3 Documentation: Replace dead link for binfmt_misc
Patch by Thomas Schwinge.

llvm-svn: 177876
2013-03-25 17:08:25 +00:00
Tobias Grosser be2c6e9734 GettingStarted: Add Git clone instructions for compiler-rt and test-suite
Contributed-by:  Thomas Schwinge  <thomas@codesourcery.com>
llvm-svn: 177841
2013-03-24 15:15:19 +00:00
Renato Golin 276ec45704 Adding ARM as supported architecture
llvm-svn: 176096
2013-02-26 17:23:13 +00:00
Renato Golin 2c2fce0e00 GCC 4.6.3 O3 miscompiles on ARM
llvm-svn: 176090
2013-02-26 13:32:40 +00:00
Michael Gottesman 4c8de298bb Fixed typo.
llvm-svn: 173478
2013-01-25 20:20:00 +00:00
Michael Gottesman 8f290a9b3a Added new section to the git-svn getting started section that provides a
custom git script called git-svnup which handles all of the work of
using the git-mirrors/keeping the git-svn numbers in sync.

llvm-svn: 173472
2013-01-25 19:31:09 +00:00
Dmitri Gribenko 09a682ab5a Documentation: remove all mentions of DejaGNU and Tcl
We don't have DejaGNU tests now.

llvm-svn: 172836
2013-01-18 19:27:43 +00:00
Sean Silva 92a44897a2 docs: Fix long standing linking antipattern.
Before we learned about :doc:, we used :ref: and put a dummy link at the
top of each page. Don't do that anymore.

This fixes PR14891 as a special case.

llvm-svn: 172162
2013-01-11 02:28:08 +00:00
Sean Silva 8e68b792b4 docs: fix broken link.
PR14889

llvm-svn: 172046
2013-01-10 06:39:37 +00:00
Dmitri Gribenko 0655f6c3d9 Documentation: add a note that Clang on Mageia 2 can not find libstdc++ headers
llvm-svn: 171729
2013-01-07 12:17:44 +00:00
Dmitri Gribenko d326f6723a Documentation: add clang 3.0 + libstdc++ 4.7.x as a known bad combination that
is actually used by a few Linux distributions

llvm-svn: 171671
2013-01-06 21:23:27 +00:00
Renato Golin cd48362e62 Add reference to dcommit on GettingStarted
Signed-off-by: Renato Golin <renato.golin@linaro.org>
llvm-svn: 171642
2013-01-06 00:14:27 +00:00
Dmitri Gribenko 801e76900d GettingStarted: improve formatting and document that configure checks for
'clang' to use it as the compiler.

llvm-svn: 171630
2013-01-05 18:10:06 +00:00
Sean Silva fe15616449 docs: Show TOC for GettingStarted.rst.
This is a pretty lengthy document, so put the table of contents in your
face so that it's easier to scope out the content.

This document is a mess currently and needs to be
refactored/revised/split-up.

llvm-svn: 170646
2012-12-20 03:32:39 +00:00
Dmitri Gribenko 125939cbf7 Documentation: use a 'console' highlighter for terminal output examples. This
gives a nicer output than 'bash'.

llvm-svn: 169979
2012-12-12 13:56:37 +00:00
NAKAMURA Takumi 5e74510398 docs: [CMake] Add Xcode to the list of project formats CMake can generate.
Suggested by Sean McBride, thanks!

llvm-svn: 168745
2012-11-27 23:34:28 +00:00
Sean Silva 23344e4981 docs: Fix highlighting.
.git/config was marked as "bash" instead of "ini".

llvm-svn: 168365
2012-11-20 12:36:27 +00:00
Dmitri Gribenko 162c524ce7 Documentation: fix broken link.
llvm-svn: 168285
2012-11-18 10:32:14 +00:00
Joel Jones 8fe56e00ed Add description of how to build docs
llvm-svn: 168088
2012-11-15 21:15:08 +00:00
Sean Silva a89edf6a61 docs: Sphinxify TestingGuide
llvm-svn: 167979
2012-11-14 21:09:30 +00:00
NAKAMURA Takumi 66304d5411 GettingStarted.rst: s/&amp;/&/g
llvm-svn: 165690
2012-10-11 01:10:37 +00:00
NAKAMURA Takumi 4b71c205b9 GettingStarted.rst: Fix the label to DeveloperPolicy.html.
llvm-svn: 165689
2012-10-11 01:10:27 +00:00
Sean Silva 9ce5c06626 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
Sean Silva a4fe992756 Silence Sphinx warnings.
Found the fix on this page:
http://permalink.gmane.org/gmane.comp.python.sphinx.devel/112

llvm-svn: 165380
2012-10-07 18:49:28 +00:00
Bill Wendling 954e430e9b Sphinxify the GettinStarted documentation.
llvm-svn: 165372
2012-10-07 07:10:13 +00:00