X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStarted.rst;h=c2c3073d5dc912a097ae70963164763a37ac79f4;hb=4839a7de4b4ab932c25b67324b629cefa3b230cd;hp=2515c9dbcdbbc8d43bb1ceeb86bdf57ca14ca820;hpb=9409a64eb07b1558191fd313eb6fc871f2b2a6a0;p=oota-llvm.git diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index 2515c9dbcdb..c2c3073d5dc 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -81,7 +81,7 @@ Here's the short story for getting up and running quickly with LLVM: * ``make [-j]`` --- The ``-j`` specifies the number of jobs (commands) to run simultaneously. This builds both LLVM and Clang for Debug+Asserts mode. - The ``--enabled-optimized`` configure option is used to specify a Release + The ``--enable-optimized`` configure option is used to specify a Release build. * ``make check-all`` --- This run the regression tests to ensure everything @@ -217,9 +217,7 @@ uses the package and provides other details. +--------------------------------------------------------------+-----------------+---------------------------------------------+ | `SVN `_ | >=1.3 | Subversion access to LLVM\ :sup:`2` | +--------------------------------------------------------------+-----------------+---------------------------------------------+ -| `python `_ | >=2.4 | Automated test suite\ :sup:`3` | -+--------------------------------------------------------------+-----------------+---------------------------------------------+ -| `perl `_ | >=5.6.0 | Utilities | +| `python `_ | >=2.5 | Automated test suite\ :sup:`3` | +--------------------------------------------------------------+-----------------+---------------------------------------------+ | `GNU M4 `_ | 1.4 | Macro processor for configuration\ :sup:`4` | +--------------------------------------------------------------+-----------------+---------------------------------------------+ @@ -229,6 +227,8 @@ uses the package and provides other details. +--------------------------------------------------------------+-----------------+---------------------------------------------+ | `libtool `_ | 1.5.22 | Shared library manager\ :sup:`4` | +--------------------------------------------------------------+-----------------+---------------------------------------------+ +| `zlib `_ | >=1.2.3.4 | Compression library\ :sup:`5` | ++--------------------------------------------------------------+-----------------+---------------------------------------------+ .. note:: @@ -243,6 +243,8 @@ uses the package and provides other details. #. If you want to make changes to the configure scripts, you will need GNU autoconf (2.60), and consequently, GNU M4 (version 1.4 or higher). You will also need automake (1.9.6). We only use aclocal from that package. + #. Optional, adds compression/uncompression capabilities to selected LLVM + tools. Additionally, your compilation host is expected to have the usual plethora of Unix utilities. Specifically: @@ -389,6 +391,11 @@ recommend using the system GCC to compile LLVM and Clang in this case. **Clang 3.0 on Mageia 2**. There's a packaging issue: Clang can not find at least some (``cxxabi.h``) libstdc++ headers. +**Clang in C++11 mode and libstdc++ 4.7.2**. This version of libstdc++ +contained `a bug `__ which +causes Clang to refuse to compile condition_variable header file. At the time +of writing, this breaks LLD build. + .. _Getting Started with LLVM: Getting Started with LLVM @@ -455,15 +462,6 @@ The files are as follows, with *x.y* marking the version number: Source release for the LLVM test-suite. -``llvm-gcc-4.2-x.y.source.tar.gz`` - - Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root - directory for build instructions. - -``llvm-gcc-4.2-x.y-platform.tar.gz`` - - Binary release of the llvm-gcc-4.2 front end for a specific platform. - .. _checkout: Checkout LLVM from Subversion @@ -486,6 +484,8 @@ you can checkout it from the '``tags``' directory (instead of '``trunk``'). The following releases are located in the following subdirectories of the '``tags``' directory: +* Release 3.3: **RELEASE_33/final** +* Release 3.2: **RELEASE_32/final** * Release 3.1: **RELEASE_31/final** * Release 3.0: **RELEASE_30/final** * Release 2.9: **RELEASE_29/final** @@ -521,13 +521,13 @@ By placing it in the ``llvm/projects``, it will be automatically configured by the LLVM configure script as well as automatically updated when you run ``svn update``. -GIT mirror +Git Mirror ---------- -GIT mirrors are available for a number of LLVM subprojects. These mirrors sync +Git mirrors are available for a number of LLVM subprojects. These mirrors sync automatically with each Subversion commit and contain all necessary git-svn marks (so, you can recreate git-svn metadata locally). Note that right now -mirrors reflect only ``trunk`` for each project. You can do the read-only GIT +mirrors reflect only ``trunk`` for each project. You can do the read-only Git clone of LLVM via: .. code-block:: console @@ -642,7 +642,7 @@ To set up clone from which you can submit code using ``git-svn``, run: Likewise for compiler-rt and test-suite. To update this clone without generating git-svn tags that conflict with the -upstream git repo, run: +upstream Git repo, run: .. code-block:: console @@ -659,35 +659,20 @@ This leaves your working directories on their master branches, so you'll need to ``checkout`` each working branch individually and ``rebase`` it on top of its parent branch. -For those who wish to be able to update an llvm repo in a simpler fashion, -consider placing the following git script in your path under the name -``git-svnup``: +For those who wish to be able to update an llvm repo/revert patches easily using +git-svn, please look in the directory for the scripts ``git-svnup`` and +``git-svnrevert``. -.. code-block:: bash +To perform the aforementioned update steps go into your source directory and +just type ``git-svnup`` or ``git svnup`` and everything will just work. - #!/bin/bash +If one wishes to revert a commit with git-svn, but do not want the git hash to +escape into the commit message, one can use the script ``git-svnrevert`` or +``git svnrevert`` which will take in the git hash for the commit you want to +revert, look up the appropriate svn revision, and output a message where all +references to the git hash have been replaced with the svn revision. - STATUS=$(git status -s | grep -v "??") - - if [ ! -z "$STATUS" ]; then - STASH="yes" - git stash >/dev/null - fi - - git fetch - OLD_BRANCH=$(git rev-parse --abbrev-ref HEAD) - git checkout master 2> /dev/null - git svn rebase -l - git checkout $OLD_BRANCH 2> /dev/null - - if [ ! -z $STASH ]; then - git stash pop >/dev/null - fi - -Then to perform the aforementioned update steps go into your source directory -and just type ``git-svnup`` or ``git svnup`` and everything will just work. - -To commit back changes via git-svn, use ``dcommit``: +To commit back changes via git-svn, use ``git svn dcommit``: .. code-block:: console @@ -769,8 +754,8 @@ The following options can be used to set or enable LLVM specific options: target names that you want available in llc. The target names use all lower case. The current set of targets is: - ``arm, cpp, hexagon, mblaze, mips, mipsel, msp430, powerpc, ptx, sparc, spu, - x86, x86_64, xcore``. + ``arm, cpp, hexagon, mips, mipsel, msp430, powerpc, ptx, sparc, spu, + systemz, x86, x86_64, xcore``. ``--enable-doxygen`` @@ -950,6 +935,10 @@ GCC compiler supports. The result of such a build is executables that are not runnable on on the build host (--build option) but can be executed on the compile host (--host option). +Check :doc:`HowToCrossCompileLLVM` and `Clang docs on how to cross-compile in general +`_ for more information +about cross-compiling. + The Location of LLVM Object Files --------------------------------- @@ -1085,7 +1074,7 @@ different `tools`_. This directory holds the source code for the LLVM assembly language parser library. -``llvm/lib/BitCode/`` +``llvm/lib/Bitcode/`` This directory holds code for reading and write LLVM bitcode. @@ -1323,7 +1312,7 @@ Example with clang Clang works just like GCC by default. The standard -S and -c arguments work as usual (producing a native .s or .o file, respectively). -#. Next, compile the C file into a LLVM bitcode file: +#. Next, compile the C file into an LLVM bitcode file: .. code-block:: console