CbC/CbC_llvm: docs/GettingStarted.rst comparison

comparison docs/GettingStarted.rst @ 148:63bd29f05246

merged

author	Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date	Wed, 14 Aug 2019 19:46:37 +0900
parents	c2174574ed3a
children

comparison

equal deleted inserted replaced

-:3fc4d5c3e21e
+:63bd29f05246
 :local:
 Overview
 ========
-Welcome to LLVM! In order to get started, you first need to know some basic
+Welcome to the LLVM project! In order to get started, you first need to know
-information.
+some basic information.
-First, LLVM comes in three pieces. The first piece is the LLVM suite. This
+First, the LLVM project has multiple components. The core of the project is
-contains all of the tools, libraries, and header files needed to use LLVM.  It
+itself called "LLVM". This contains all of the tools, libraries, and header
-contains an assembler, disassembler, bitcode analyzer and bitcode optimizer.  It
+files needed to process an intermediate representation and convert it into
-also contains basic regression tests that can be used to test the LLVM tools and
+object files.  It contains an assembler, disassembler, bitcode analyzer and
-the Clang front end.
+bitcode optimizer.  It also contains basic regression tests.
-The second piece is the `Clang <http://clang.llvm.org/>`_ front end.  This
+Another piece is the `Clang <http://clang.llvm.org/>`_ front end.  This
-component compiles C, C++, Objective C, and Objective C++ code into LLVM
+component compiles C, C++, Objective C, and Objective C++ code into LLVM bitcode
-bitcode. Once compiled into LLVM bitcode, a program can be manipulated with the
+-- and from there into object files, using LLVM.
-LLVM tools from the LLVM suite.
+There are other components as well:
-There is a third, optional piece called Test Suite.  It is a suite of programs
+the `libc++ C++ standard library <https://libcxx.llvm.org>`_,
-with a testing harness that can be used to further test LLVM's functionality
+the `LLD linker <https://lld.llvm.org>`_, and more.
-and performance.
 Getting Started Quickly (A Summary)
 ===================================
 The LLVM Getting Started documentation may be out of date.  So, the `Clang
 #. Read the documentation.
 #. Read the documentation.
 #. Remember that you were warned twice about reading the documentation.
-* In particular, the *relative paths specified are important*.
+#. Checkout LLVM (including related subprojects like Clang):
-#. Checkout LLVM:
+* ``git clone https://github.com/llvm/llvm-project.git``
+* Or, on windows, ``git clone --config core.autocrlf=false
-* ``cd where-you-want-llvm-to-live``
+https://github.com/llvm/llvm-project.git``
-* ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
+#. Configure and build LLVM and Clang:.
-#. Checkout Clang:
+* ``cd llvm-project``
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/tools``
-* ``svn co http://llvm.org/svn/llvm-project/cfe/trunk clang``
-#. Checkout Extra Clang Tools **[Optional]**:
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/tools/clang/tools``
-* ``svn co http://llvm.org/svn/llvm-project/clang-tools-extra/trunk extra``
-#. Checkout LLD linker **[Optional]**:
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/tools``
-* ``svn co http://llvm.org/svn/llvm-project/lld/trunk lld``
-#. Checkout Polly Loop Optimizer **[Optional]**:
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/tools``
-* ``svn co http://llvm.org/svn/llvm-project/polly/trunk polly``
-#. Checkout Compiler-RT (required to build the sanitizers) **[Optional]**:
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/projects``
-* ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
-#. Checkout Libomp (required for OpenMP support) **[Optional]**:
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/projects``
-* ``svn co http://llvm.org/svn/llvm-project/openmp/trunk openmp``
-#. Checkout libcxx and libcxxabi **[Optional]**:
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/projects``
-* ``svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx``
-* ``svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi``
-#. Get the Test Suite Source Code **[Optional]**
-* ``cd where-you-want-llvm-to-live``
-* ``cd llvm/projects``
-* ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite``
-#. Configure and build LLVM and Clang:
-*Warning:* Make sure you've checked out *all of* the source code
-before trying to configure with cmake.  cmake does not pickup newly
-added source directories in incremental builds.
-The build uses `CMake <CMake.html>`_. LLVM requires CMake 3.4.3 to build. It
-is generally recommended to use a recent CMake, especially if you're
-generating Ninja build files. This is because the CMake project is constantly
-improving the quality of the generators, and the Ninja generator gets a lot
-of attention.
-* ``cd where you want to build llvm``
 * ``mkdir build``
 * ``cd build``
-* ``cmake -G <generator> [options] <path to llvm sources>``
+* ``cmake -G <generator> [options] ../llvm``
 Some common generators are:
-* ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
 * ``Ninja`` --- for generating `Ninja <https://ninja-build.org>`_
 build files. Most llvm developers use Ninja.
+* ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
 * ``Visual Studio`` --- for generating Visual Studio projects and
 solutions.
 * ``Xcode`` --- for generating Xcode projects.
 Some Common options:
+* ``-DLLVM_ENABLE_PROJECTS='...'`` --- semicolon-separated list of the LLVM
+subprojects you'd like to additionally build. Can include any of: clang,
+clang-tools-extra, libcxx, libcxxabi, libunwind, lldb, compiler-rt, lld,
+polly, or debuginfo-tests.
+For example, to build LLVM, Clang, libcxx, and libcxxabi, use
+``-DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi"``.
 * ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full
 pathname of where you want the LLVM tools and libraries to be installed
 (default ``/usr/local``).
 * ``-DCMAKE_BUILD_TYPE=type`` --- Valid options for *type* are Debug,
 * ``-DLLVM_ENABLE_ASSERTIONS=On`` --- Compile with assertion checks enabled
 (default is Yes for Debug builds, No for all other build types).
 * Run your build tool of choice!
-* The default target (i.e. ``make``) will build all of LLVM
+* The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.
-* The ``check-all`` target (i.e. ``make check-all``) will run the
+* The ``check-all`` target (i.e. ``ninja check-all``) will run the
 regression tests to ensure everything is in working order.
 * CMake will generate build targets for each tool and library, and most
 LLVM sub-projects generate their own ``check-<project>`` target.
-* Running a serial build will be *slow*.  Make sure you run a
+* Running a serial build will be *slow*.  Make sure you run a parallel
-parallel build; for ``make``, use ``make -j``.
+build. That's already done by default in Ninja; for ``make``, use
+``make -j NNN`` (with an appropriate value of NNN, e.g. number of CPUs
+you have.)
 * For more information see `CMake <CMake.html>`_
 * If you get an "internal compiler error (ICE)" or test failures, see
 `below`_.
 ================== ===================== =============
 OS                 Arch                  Compilers
 ================== ===================== =============
 Linux              x86\ :sup:`1`         GCC, Clang
 Linux              amd64                 GCC, Clang
-Linux              ARM\ :sup:`4`         GCC, Clang
+Linux              ARM                   GCC, Clang
 Linux              PowerPC               GCC, Clang
 Solaris            V9 (Ultrasparc)       GCC
 FreeBSD            x86\ :sup:`1`         GCC, Clang
 FreeBSD            amd64                 GCC, Clang
 NetBSD             x86\ :sup:`1`         GCC, Clang
 NetBSD             amd64                 GCC, Clang
-MacOS X\ :sup:`2`  PowerPC               GCC
+macOS\ :sup:`2`    PowerPC               GCC
-MacOS X            x86                   GCC, Clang
+macOS              x86                   GCC, Clang
 Cygwin/Win32       x86\ :sup:`1, 3`      GCC
 Windows            x86\ :sup:`1`         Visual Studio
 Windows x64        x86-64                Visual Studio
 ================== ===================== =============
 #. Code generation supported for Pentium processors and up
 #. Code generation supported for 32-bit ABI only
 #. To use LLVM modules on Win32-based system, you may configure LLVM
 with ``-DBUILD_SHARED_LIBS=On``.
-#. MCJIT not working well pre-v7, old JIT engine not supported any more.
 Note that Debug builds require a lot of time and disk space.  An LLVM-only build
 will need about 1-3 GB of space.  A full build of LLVM and Clang will need around
 15-20 GB of disk space.  The exact space requirements will vary by system.  (It
 is so large because of all the debugging information and the fact that the
 libraries are statically linked into multiple tools).
-If you you are space-constrained, you can build only selected tools or only
+If you are space-constrained, you can build only selected tools or only
 selected targets.  The Release build requires considerably less space.
 The LLVM suite *may* compile on other platforms, but it is not guaranteed to do
 so.  If compilation is successful, the LLVM utilities should be able to
 assemble, disassemble, analyze, and optimize LLVM bitcode.  Code generation
 uses the package and provides other details.
 =========================================================== ============ ==========================================
 Package                                                     Version      Notes
 =========================================================== ============ ==========================================
-`GNU Make <http://savannah.gnu.org/projects/make>`_         3.79, 3.79.1 Makefile/build processor
+`CMake <http://cmake.org/>`_                                >=3.4.3      Makefile/workspace generator
-`GCC <http://gcc.gnu.org/>`_                                >=4.8.0      C/C++ compiler\ :sup:`1`
+`GCC <http://gcc.gnu.org/>`_                                >=5.1.0      C/C++ compiler\ :sup:`1`
 `python <http://www.python.org/>`_                          >=2.7        Automated test suite\ :sup:`2`
 `zlib <http://zlib.net>`_                                   >=1.2.3.4    Compression library\ :sup:`3`
+`GNU Make <http://savannah.gnu.org/projects/make>`_         3.79, 3.79.1 Makefile/build processor\ :sup:`4`
 =========================================================== ============ ==========================================
 .. note::
 #. Only the C and C++ languages are needed so there's no need to build the
 info.
 #. Only needed if you want to run the automated test suite in the
 ``llvm/test`` directory.
 #. Optional, adds compression / uncompression capabilities to selected LLVM
 tools.
+#. Optional, you can use any other build tool supported by CMake.
 Additionally, your compilation host is expected to have the usual plethora of
 Unix utilities. Specifically:
 * **ar** --- archive library builder
 Host C++ Toolchain, both Compiler and Standard Library
 ------------------------------------------------------
 LLVM is very demanding of the host C++ compiler, and as such tends to expose
-bugs in the compiler. We are also planning to follow improvements and
+bugs in the compiler. We also attempt to follow improvements and developments in
-developments in the C++ language and library reasonably closely. As such, we
+the C++ language and library reasonably closely. As such, we require a modern
-require a modern host C++ toolchain, both compiler and standard library, in
+host C++ toolchain, both compiler and standard library, in order to build LLVM.
-order to build LLVM.
+LLVM is written using the subset of C++ documented in :doc:`coding
-For the most popular host toolchains we check for specific minimum versions in
+standards<CodingStandards>`. To enforce this language version, we check the most
-our build systems:
+popular host toolchains for specific minimum versions in our build systems:
+* Clang 3.5
+* Apple Clang 6.0
+* GCC 5.1
+* Visual Studio 2017
+The below versions currently soft-error as we transition to the new compiler
+versions listed above. The LLVM codebase is currently known to compile correctly
+with the following compilers, though this will change in the near future:
 * Clang 3.1
+* Apple Clang 3.1
 * GCC 4.8
-* Visual Studio 2015 (Update 3)
+* Visual Studio 2017
 Anything older than these toolchains *may* work, but will require forcing the
 build system with a special option and is not really a supported host platform.
 Also note that older versions of these compilers have often crashed or
 miscompiled LLVM.
 newer version of Gold.
 Getting a Modern Host C++ Toolchain
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-This section mostly applies to Linux and older BSDs. On Mac OS X, you should
+This section mostly applies to Linux and older BSDs. On macOS, you should
 have a sufficiently modern Xcode, or you will likely need to upgrade until you
 do. Windows does not have a "system compiler", so you must install either Visual
-Studio 2015 or a recent version of mingw64. FreeBSD 10.0 and newer have a modern
+Studio 2017 or a recent version of mingw64. FreeBSD 10.0 and newer have a modern
 Clang as the system compiler.
 However, some Linux distributions and some other or older BSDs sometimes have
 extremely old versions of GCC. These steps attempt to help you upgrade you
 compiler even on such a system. However, if at all possible, we encourage you
 The first step is to get a recent GCC toolchain installed. The most common
 distribution on which users have struggled with the version requirements is
 Ubuntu Precise, 12.04 LTS. For this distribution, one easy option is to install
 the `toolchain testing PPA`_ and use it to install a modern GCC. There is
-a really nice discussions of this on the `ask ubuntu stack exchange`_. However,
+a really nice discussions of this on the `ask ubuntu stack exchange`_ and a
-not all users can use PPAs and there are many other distributions, so it may be
+`github gist`_ with updated commands. However, not all users can use PPAs and
-necessary (or just useful, if you're here you *are* doing compiler development
+there are many other distributions, so it may be necessary (or just useful, if
-after all) to build and install GCC from source. It is also quite easy to do
+you're here you *are* doing compiler development after all) to build and install
-these days.
+GCC from source. It is also quite easy to do these days.
 .. _toolchain testing PPA:
 https://launchpad.net/~ubuntu-toolchain-r/+archive/test
 .. _ask ubuntu stack exchange:
-http://askubuntu.com/questions/271388/how-to-install-gcc-4-8-in-ubuntu-12-04-from-the-terminal
+https://askubuntu.com/questions/466651/how-do-i-use-the-latest-gcc-on-ubuntu/581497#58149
+.. _github gist:
-Easy steps for installing GCC 4.8.2:
+https://gist.github.com/application2000/73fd6f4bf1be6600a2cf9f56315a2d91
-.. code-block:: console
+Easy steps for installing GCC 5.1.0:
-% wget https://ftp.gnu.org/gnu/gcc/gcc-4.8.2/gcc-4.8.2.tar.bz2
+.. code-block:: console
-% wget https://ftp.gnu.org/gnu/gcc/gcc-4.8.2/gcc-4.8.2.tar.bz2.sig
+% gcc_version=5.1.0
+% wget https://ftp.gnu.org/gnu/gcc/gcc-${gcc_version}/gcc-${gcc_version}.tar.bz2
+% wget https://ftp.gnu.org/gnu/gcc/gcc-${gcc_version}/gcc-${gcc_version}.tar.bz2.sig
 % wget https://ftp.gnu.org/gnu/gnu-keyring.gpg
-% signature_invalid=`gpg --verify --no-default-keyring --keyring ./gnu-keyring.gpg gcc-4.8.2.tar.bz2.sig`
+% signature_invalid=`gpg --verify --no-default-keyring --keyring ./gnu-keyring.gpg gcc-${gcc_version}.tar.bz2.sig`
 % if [ $signature_invalid ]; then echo "Invalid signature" ; exit 1 ; fi
-% tar -xvjf gcc-4.8.2.tar.bz2
+% tar -xvjf gcc-${gcc_version}.tar.bz2
-% cd gcc-4.8.2
+% cd gcc-${gcc_version}
 % ./contrib/download_prerequisites
 % cd ..
-% mkdir gcc-4.8.2-build
+% mkdir gcc-${gcc_version}-build
-% cd gcc-4.8.2-build
+% cd gcc-${gcc_version}-build
-% $PWD/../gcc-4.8.2/configure --prefix=$HOME/toolchains --enable-languages=c,c++
+% $PWD/../gcc-${gcc_version}/configure --prefix=$HOME/toolchains --enable-languages=c,c++
 % make -j$(nproc)
 % make install
 For more details, check out the excellent `GCC wiki entry`_, where I got most
 of this information from.
 .. _GCC wiki entry:
-http://gcc.gnu.org/wiki/InstallingGCC
+https://gcc.gnu.org/wiki/InstallingGCC
 Once you have a GCC toolchain, configure your build of LLVM to use the new
 toolchain for your host compiler and C++ standard library. Because the new
 version of libstdc++ is not on the system library search path, you need to pass
 extra linker flags so that it can be found at link time (``-L``) and at runtime
 If you fail to set rpath, most LLVM binaries will fail on startup with a message
 from the loader similar to ``libstdc++.so.6: version `GLIBCXX_3.4.20' not
 found``. This means you need to tweak the -rpath linker flag.
-When you build Clang, you will need to give *it* access to modern C++11
+When you build Clang, you will need to give *it* access to modern C++
 standard library in order to use it as your new host in part of a bootstrap.
 There are two easy ways to do this, either build (and install) libc++ along
 with Clang and then use it with the ``-stdlib=libc++`` compile and link flag,
 or install Clang into the same prefix (``$HOME/toolchains`` above) as GCC.
 Clang will look within its own prefix for libstdc++ and use it if found. You
 Unpacking the LLVM Archives
 ---------------------------
 If you have the LLVM distribution, you will need to unpack it before you can
-begin to compile it.  LLVM is distributed as a set of two files: the LLVM suite
+begin to compile it.  LLVM is distributed as a number of different
-and the LLVM GCC front end compiled for your platform.  There is an additional
+subprojects. Each one has its own download which is a TAR archive that is
-test suite that is optional.  Each file is a TAR archive that is compressed with
+compressed with the gzip program.
-the gzip program.
 The files are as follows, with *x.y* marking the version number:
 ``llvm-x.y.tar.gz``
 Source release for the LLVM libraries and tools.
-``llvm-test-x.y.tar.gz``
+``cfe-x.y.tar.gz``
-Source release for the LLVM test-suite.
+Source release for the Clang frontend.
 .. _checkout:
-Checkout LLVM from Subversion
+Checkout LLVM from Git
------------------------------
+----------------------
-If you have access to our Subversion repository, you can get a fresh copy of the
+You can also checkout the source code for LLVM from Git. While the LLVM
-entire source code.  All you need to do is check it out from Subversion as
+project's official source-code repository is Subversion, we are in the process
-follows:
+of migrating to git. We currently recommend that all developers use Git for
+day-to-day development.
+.. note::
+Passing ``--config core.autocrlf=false`` should not be required in
+the future after we adjust the .gitattribute settings correctly, but
+is required for Windows users at the time of this writing.
+Simply run:
+.. code-block:: console
+% git clone https://github.com/llvm/llvm-project.git
+or on Windows,
+.. code-block:: console
+% git clone --config core.autocrlf=false https://github.com/llvm/llvm-project.git
+This will create an '``llvm-project``' directory in the current directory and
+fully populate it with all of the source code, test directories, and local
+copies of documentation files for LLVM and all the related subprojects. Note
+that unlike the tarballs, which contain each subproject in a separate file, the
+git repository contains all of the projects together.
+If you want to get a specific release (as opposed to the most recent revision),
+you can check out a tag after cloning the repository. E.g., `git checkout
+llvmorg-6.0.1` inside the ``llvm-project`` directory created by the above
+command.  Use `git tag -l` to list all of them.
+Sending patches
+^^^^^^^^^^^^^^^
+Please read `Developer Policy <DeveloperPolicy.html#one-off-patches>`_, too.
+We don't currently accept github pull requests, so you'll need to send patches
+either via emailing to llvm-commits, or, preferably, via :ref:`Phabricator
+<phabricator-reviews>`.
+You'll generally want to make sure your branch has a single commit,
+corresponding to the review you wish to send, up-to-date with the upstream
+``origin/master`` branch, and doesn't contain merges. Once you have that, you
+can use ``git show`` or ``git format-patch`` to output the diff, and attach it
+to a Phabricator review (or to an email message).
+However, using the "Arcanist" tool is often easier. After `installing
+arcanist`_, you can upload the latest commit using:
+.. code-block:: console
+% arc diff HEAD~1
+Additionally, before sending a patch for review, please also try to ensure it's
+formatted properly. We use ``clang-format`` for this, which has git integration
+through the ``git-clang-format`` script. On some systems, it may already be
+installed (or be installable via your package manager). If so, you can simply
+run it -- the following command will format only the code changed in the most
+recent commit:
+.. code-block:: console
+% git clang-format HEAD~1
+Note that this modifies the files, but doesn't commit them -- you'll likely want
+to run
+.. code-block:: console
+% git commit --amend -a
+in order to update the last commit with all pending changes.
+.. note::
+If you don't already have ``clang-format`` or ``git clang-format`` installed
+on your system, the ``clang-format`` binary will be built alongside clang, and
+the git integration can be run from
+``clang/tools/clang-format/git-clang-format``.
+.. _commit_from_git:
+For developers to commit changes from Git
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A helper script is provided in ``llvm/utils/git-svn/git-llvm``. After you add it
+to your path, you can push committed changes upstream with ``git llvm
+push``. While this creates a Subversion checkout and patches it under the hood,
+it does not require you to have interaction with it.
+.. code-block:: console
+% export PATH=$PATH:$TOP_LEVEL_DIR/llvm-project/llvm/utils/git-svn/
+% git llvm push
+Within a couple minutes after pushing to subversion, the svn commit will have
+been converted back to a Git commit, and made its way into the official Git
+repository. At that point, ``git pull`` should get back the changes as they were
+committed.
+You'll likely want to ``git pull --rebase`` to get the official git commit
+downloaded back to your repository. The SVN revision numbers of each commit can
+be found at the end of the commit message, e.g. ``llvm-svn: 350914``.
+You may also find the ``-n`` flag useful, like ``git llvm push -n``. This runs
+through all the steps of committing _without_ actually doing the commit, and
+tell you what it would have done. That can be useful if you're unsure whether
+the right thing will happen.
+Reverting a change when using Git
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If you're using Git and need to revert a patch, Git needs to be supplied a
+commit hash, not an svn revision. To make things easier, you can use
+``git llvm revert`` to revert with either an SVN revision or a Git hash instead.
+Additionally, you can first run with ``git llvm revert -n`` to print which Git
+commands will run, without doing anything.
+Running ``git llvm revert`` will only revert things in your local repository. To
+push the revert upstream, you still need to run ``git llvm push`` as described
+earlier.
+.. code-block:: console
+% git llvm revert rNNNNNN       # Revert by SVN id
+% git llvm revert abcdef123456  # Revert by Git commit hash
+% git llvm revert -n rNNNNNN    # Print the commands without doing anything
+Checkout via SVN (deprecated)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Until we have fully migrated to Git, you may also get a fresh copy of
+the code from the official Subversion repository.
 * ``cd where-you-want-llvm-to-live``
 * Read-Only: ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
 * Read-Write: ``svn co https://user@llvm.org/svn/llvm-project/llvm/trunk llvm``
 * Release 3.5.0 and later: **RELEASE_350/final** and so on
 * Release 2.9 through 3.4: **RELEASE_29/final** and so on
 * Release 1.1 through 2.8: **RELEASE_11** and so on
 * Release 1.0: **RELEASE_1**
-If you would like to get the LLVM test suite (a separate package as of 1.4), you
-get it from the Subversion repository:
-.. code-block:: console
-% cd llvm/projects
-% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
-By placing it in the ``llvm/projects``, it will be automatically configured by
-the LLVM cmake configuration.
-Git Mirror
-----------
-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
-clone of LLVM via:
-.. code-block:: console
-% git clone https://git.llvm.org/git/llvm.git/
-If you want to check out clang too, run:
-.. code-block:: console
-% cd llvm/tools
-% git clone https://git.llvm.org/git/clang.git/
-If you want to check out compiler-rt (required to build the sanitizers), run:
-.. code-block:: console
-% cd llvm/projects
-% git clone https://git.llvm.org/git/compiler-rt.git/
-If you want to check out libomp (required for OpenMP support), run:
-.. code-block:: console
-% cd llvm/projects
-% git clone https://git.llvm.org/git/openmp.git/
-If you want to check out libcxx and libcxxabi (optional), run:
-.. code-block:: console
-% cd llvm/projects
-% git clone https://git.llvm.org/git/libcxx.git/
-% git clone https://git.llvm.org/git/libcxxabi.git/
-If you want to check out the Test Suite Source Code (optional), run:
-.. code-block:: console
-% cd llvm/projects
-% git clone https://git.llvm.org/git/test-suite.git/
-Since the upstream repository is in Subversion, you should use ``git
-pull --rebase`` instead of ``git pull`` to avoid generating a non-linear history
-in your clone.  To configure ``git pull`` to pass ``--rebase`` by default on the
-master branch, run the following command:
-.. code-block:: console
-% git config branch.master.rebase true
-Sending patches with Git
-^^^^^^^^^^^^^^^^^^^^^^^^
-Please read `Developer Policy <DeveloperPolicy.html#one-off-patches>`_, too.
-Assume ``master`` points the upstream and ``mybranch`` points your working
-branch, and ``mybranch`` is rebased onto ``master``.  At first you may check
-sanity of whitespaces:
-.. code-block:: console
-% git diff --check master..mybranch
-The easiest way to generate a patch is as below:
-.. code-block:: console
-% git diff master..mybranch > /path/to/mybranch.diff
-It is a little different from svn-generated diff. git-diff-generated diff has
-prefixes like ``a/`` and ``b/``. Don't worry, most developers might know it
-could be accepted with ``patch -p1 -N``.
-But you may generate patchset with git-format-patch. It generates by-each-commit
-patchset. To generate patch files to attach to your article:
-.. code-block:: console
-% git format-patch --no-attach master..mybranch -o /path/to/your/patchset
-If you would like to send patches directly, you may use git-send-email or
-git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
-.. code-block:: console
-% git format-patch --attach master..mybranch --stdout | git imap-send
-Then, your .git/config should have [imap] sections.
-.. code-block:: ini
-[imap]
-host = imaps://imap.gmail.com
-user = your.gmail.account@gmail.com
-pass = himitsu!
-port = 993
-sslverify = false
-; in English
-folder = "[Gmail]/Drafts"
-; example for Japanese, "Modified UTF-7" encoded.
-folder = "[Gmail]/&Tgtm+DBN-"
-; example for Traditional Chinese
-folder = "[Gmail]/&g0l6Pw-"
-.. _developers-work-with-git-svn:
-For developers to work with git-svn
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To set up clone from which you can submit code using ``git-svn``, run:
-.. code-block:: console
-% git clone https://git.llvm.org/git/llvm.git/
-% cd llvm
-% git svn init https://llvm.org/svn/llvm-project/llvm/trunk --username=<username>
-% git config svn-remote.svn.fetch :refs/remotes/origin/master
-% git svn rebase -l  # -l avoids fetching ahead of the git mirror.
-# If you have clang too:
-% cd tools
-% git clone https://git.llvm.org/git/clang.git/
-% cd clang
-% git svn init https://llvm.org/svn/llvm-project/cfe/trunk --username=<username>
-% git config svn-remote.svn.fetch :refs/remotes/origin/master
-% git svn rebase -l
-Likewise for compiler-rt, libomp and test-suite.
-To update this clone without generating git-svn tags that conflict with the
-upstream Git repo, run:
-.. code-block:: console
-% git fetch && (cd tools/clang && git fetch)  # Get matching revisions of both trees.
-% git checkout master
-% git svn rebase -l
-% (cd tools/clang &&
-git checkout master &&
-git svn rebase -l)
-Likewise for compiler-rt, libomp and test-suite.
-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/revert patches easily using
-git-svn, please look in the directory for the scripts ``git-svnup`` and
-``git-svnrevert``.
-To perform the aforementioned update steps go into your source directory and
-just type ``git-svnup`` or ``git svnup`` and everything will just work.
-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.
-To commit back changes via git-svn, use ``git svn dcommit``:
-.. code-block:: console
-% git svn dcommit
-Note that git-svn will create one SVN commit for each Git commit you have pending,
-so squash and edit each commit before executing ``dcommit`` to make sure they all
-conform to the coding standards and the developers' policy.
-On success, ``dcommit`` will rebase against the HEAD of SVN, so to avoid conflict,
-please make sure your current branch is up-to-date (via fetch/rebase) before
-proceeding.
-The git-svn metadata can get out of sync after you mess around with branches and
-``dcommit``. When that happens, ``git svn dcommit`` stops working, complaining
-about files with uncommitted changes. The fix is to rebuild the metadata:
-.. code-block:: console
-% rm -rf .git/svn
-% git svn rebase -l
-Please, refer to the Git-SVN manual (``man git-svn``) for more information.
-For developers to work with a git monorepo
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. note::
-This set-up is using an unofficial mirror hosted on GitHub, use with caution.
-To set up a clone of all the llvm projects using a unified repository:
-.. code-block:: console
-% export TOP_LEVEL_DIR=`pwd`
-% git clone https://github.com/llvm-project/llvm-project-20170507/ llvm-project
-% cd llvm-project
-% git config branch.master.rebase true
-You can configure various build directory from this clone, starting with a build
-of LLVM alone:
-.. code-block:: console
-% cd $TOP_LEVEL_DIR
-% mkdir llvm-build && cd llvm-build
-% cmake -GNinja ../llvm-project/llvm
-Or lldb:
-.. code-block:: console
-% cd $TOP_LEVEL_DIR
-% mkdir lldb-build && cd lldb-build
-% cmake -GNinja ../llvm-project/llvm -DLLVM_ENABLE_PROJECTS=lldb
-Or a combination of multiple projects:
-.. code-block:: console
-% cd $TOP_LEVEL_DIR
-% mkdir clang-build && cd clang-build
-% cmake -GNinja ../llvm-project/llvm -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi"
-A helper script is provided in ``llvm/utils/git-svn/git-llvm``. After you add it
-to your path, you can push committed changes upstream with ``git llvm push``.
-.. code-block:: console
-% export PATH=$PATH:$TOP_LEVEL_DIR/llvm-project/llvm/utils/git-svn/
-% git llvm push
-While this is using SVN under the hood, it does not require any interaction from
-you with git-svn.
-After a few minutes, ``git pull`` should get back the changes as they were
-committed. Note that a current limitation is that ``git`` does not directly
-record file rename, and thus it is propagated to SVN as a combination of
-delete-add instead of a file rename.
-The SVN revision of each monorepo commit can be found in the commit notes.  git
-does not fetch notes by default. The following commands will fetch the notes and
-configure git to fetch future notes. Use ``git notes show $commit`` to look up
-the SVN revision of a git commit. The notes show up ``git log``, and searching
-the log is currently the recommended way to look up the git commit for a given
-SVN revision.
-.. code-block:: console
-% git config --add remote.origin.fetch +refs/notes/commits:refs/notes/commits
-% git fetch
-If you are using `arc` to interact with Phabricator, you need to manually put it
-at the root of the checkout:
-.. code-block:: console
-% cd $TOP_LEVEL_DIR
-% cp llvm/.arcconfig ./
-% mkdir -p .git/info/
-% echo .arcconfig >> .git/info/exclude
 Local LLVM Configuration
 ------------------------
-Once checked out from the Subversion repository, the LLVM suite source code must
+Once checked out repository, the LLVM suite source code must be configured
-be configured before being built. This process uses CMake.
+before being built. This process uses CMake.  Unlinke the normal ``configure``
-Unlinke the normal ``configure`` script, CMake
+script, CMake generates the build files in whatever format you request as well
-generates the build files in whatever format you request as well as various
+as various ``*.inc`` files, and ``llvm/include/Config/config.h``.
-``*.inc`` files, and ``llvm/include/Config/config.h``.
 Variables are passed to ``cmake`` on the command line using the format
 ``-D<variable name>=<value>``. The following variables are some common options
 used by people developing LLVM.
 |                         | is Debug.                                          |
 +-------------------------+----------------------------------------------------+
 | CMAKE_INSTALL_PREFIX    | Specifies the install directory to target when     |
 |                         | running the install action of the build files.     |
 +-------------------------+----------------------------------------------------+
+| PYTHON_EXECUTABLE       | Forces CMake to use a specific Python version by   |
+|                         | passing a path to a Python interpreter. By default |
+|                         | the Python version of the interpreter in your PATH |
+|                         | is used.                                           |
++-------------------------+----------------------------------------------------+
 | LLVM_TARGETS_TO_BUILD   | A semicolon delimited list controlling which       |
-|                         | targets will be built and linked into llc. This is |
+|                         | targets will be built and linked into llvm.        |
-|                         | equivalent to the ``--enable-targets`` option in   |
+|                         | The default list is defined as                     |
-|                         | the configure script. The default list is defined  |
+|                         | ``LLVM_ALL_TARGETS``, and can be set to include    |
-|                         | as ``LLVM_ALL_TARGETS``, and can be set to include |
 |                         | out-of-tree targets. The default value includes:   |
 |                         | ``AArch64, AMDGPU, ARM, BPF, Hexagon, Mips,        |
 |                         | MSP430, NVPTX, PowerPC, Sparc, SystemZ, X86,       |
 |                         | XCore``.                                           |
+|                         |                                                    |
 +-------------------------+----------------------------------------------------+
 | LLVM_ENABLE_DOXYGEN     | Build doxygen-based documentation from the source  |
 |                         | code This is disabled by default because it is     |
 |                         | slow and generates a lot of output.                |
++-------------------------+----------------------------------------------------+
+| LLVM_ENABLE_PROJECTS    | A semicolon-delimited list selecting which of the  |
+|                         | other LLVM subprojects to additionally build. (Only|
+|                         | effective when using a side-by-side project layout |
+|                         | e.g. via git). The default list is empty. Can      |
+|                         | include: clang, libcxx, libcxxabi, libunwind, lldb,|
+|                         | compiler-rt, lld, polly, or debuginfo-tests.       |
 +-------------------------+----------------------------------------------------+
 | LLVM_ENABLE_SPHINX      | Build sphinx-based documentation from the source   |
 |                         | code. This is disabled by default because it is    |
 |                         | slow and generates a lot of output. Sphinx version |
 |                         | 1.5 or later recommended.                          |
 #. Run the ``cmake``:
 .. code-block:: console
-% cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=prefix=/install/path
+% cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=/install/path
 [other options] SRC_ROOT
 Compiling the LLVM Suite Source Code
 ------------------------------------
 cross-compiling CMake provides a variable ``CMAKE_TOOLCHAIN_FILE`` which can
 define compiler flags and variables used during the CMake test operations.
 The result of such a build is executables that are not runnable on the build
 host but can be executed on the target. As an example the following CMake
-invocation can generate build files targeting iOS. This will work on Mac OS X
+invocation can generate build files targeting iOS. This will work on macOS
 with the latest Xcode:
 .. code-block:: console
 % cmake -G "Ninja" -DCMAKE_OSX_ARCHITECTURES="armv7;armv7s;arm64"
 LLVM. For example, some C++ STL utilities and a Command Line option processing
 library store header files here.
 ``llvm/include/llvm/Config``
-Header files configured by the ``configure`` script.
+Header files configured by ``cmake``.  They wrap "standard" UNIX and
-They wrap "standard" UNIX and C header files.  Source code can include these
+C header files.  Source code can include these header files which
-header files which automatically take care of the conditional #includes that
+automatically take care of the conditional #includes that ``cmake``
-the ``configure`` script generates.
+generates.
 ``llvm/lib``
 ------------
 Most source files are here. By putting code in libraries, LLVM makes it easy to
 are intended to run quickly and cover a lot of territory without being exhaustive.
 ``test-suite``
 --------------
-A comprehensive correctness, performance, and benchmarking test suite for LLVM.
+A comprehensive correctness, performance, and benchmarking test suite
-Comes in a separate Subversion module because not every LLVM user is interested
+for LLVM.  This comes in a ``separate git repository
-in such a comprehensive suite. For details see the :doc:`Testing Guide
+<https://github.com/llvm/llvm-test-suite>``, because it contains a
-<TestingGuide>` document.
+large amount of third-party code under a variety of licenses. For
+details see the :doc:`Testing Guide <TestingGuide>` document.
 .. _tools:
 ``llvm/tools``
 --------------
 Performs an ``egrep -H -n`` on each source file in LLVM and
 passes to it a regular expression provided on ``llvmgrep``'s command
 line. This is an efficient way of searching the source base for a
 particular regular expression.
-``makellvm``
-Compiles all files in the current directory, then
-compiles and links the tool that is the first argument. For example, assuming
-you are in  ``llvm/lib/Target/Sparc``, if ``makellvm`` is in your
-path,  running ``makellvm llc`` will make a build of the current
-directory, switch to directory ``llvm/tools/llc`` and build it, causing a
-re-linking of LLC.
 ``TableGen/``
 Contains the tool used to generate register
 descriptions, instruction set descriptions, and even assemblers from common
 TableGen description files.
 write something up!).  For more information about LLVM, check out:
 * `LLVM Homepage <http://llvm.org/>`_
 * `LLVM Doxygen Tree <http://llvm.org/doxygen/>`_
 * `Starting a Project that Uses LLVM <http://llvm.org/docs/Projects.html>`_
+.. _installing arcanist: https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start/

Mercurial > hg > CbC > CbC_llvm

comparison docs/GettingStarted.rst @ 148:63bd29f05246