Adjust documentation for git migration.
This fixes most references to the paths:
llvm.org/svn/
llvm.org/git/
llvm.org/viewvc/
github.com/llvm-mirror/
github.com/llvm-project/
reviews.llvm.org/diffusion/
to instead point to https://github.com/llvm/llvm-project.
This is *not* a trivial substitution, because additionally, all the
checkout instructions had to be migrated to instruct users on how to
use the monorepo layout, setting LLVM_ENABLE_PROJECTS instead of
checking out various projects into various subdirectories.
I've attempted to not change any scripts here, only documentation. The
scripts will have to be addressed separately.
Additionally, I've deleted one document which appeared to be outdated
and unneeded:
lldb/docs/building-with-debug-llvm.txt
Differential Revision: https://reviews.llvm.org/D57330
llvm-svn: 352514
Cr-Mirrored-From: sso://chromium.googlesource.com/_direct/external/github.com/llvm/llvm-project
Cr-Mirrored-Commit: 5d71fc5d7b5ffe2323418a09db6eddaf84d6c662
diff --git a/docs/BuildingLibcxx.rst b/docs/BuildingLibcxx.rst
index a498c00..01f442d 100644
--- a/docs/BuildingLibcxx.rst
+++ b/docs/BuildingLibcxx.rst
@@ -18,33 +18,10 @@
The basic steps needed to build libc++ are:
-#. Checkout LLVM:
-
- * ``cd where-you-want-llvm-to-live``
- * ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
-
-#. Checkout libc++:
-
- * ``cd where-you-want-llvm-to-live``
- * ``cd llvm/projects``
- * ``svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx``
-
-#. Checkout libc++abi:
-
- * ``cd where-you-want-llvm-to-live``
- * ``cd llvm/projects``
- * ``svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi``
-
-#. Configure and build libc++ with libc++abi:
-
- CMake is the only supported configuration system.
-
- Clang is the preferred compiler when building and using libc++.
-
- * ``cd where you want to build llvm``
- * ``mkdir build``
- * ``cd build``
- * ``cmake -G <generator> [options] <path to llvm sources>``
+#. Checkout and configure LLVM (including libc++ and libc++abi), according to the `LLVM
+ getting started <https://llvm.org/docs/GettingStarted.html>`_ documentation. Make sure
+ to include ``libcxx`` and ``libcxxabi`` in the ``LLVM_ENABLE_PROJECTS`` option passed
+ to CMake.
For more information about configuring libc++ see :ref:`CMake Options`.
@@ -71,23 +48,21 @@
FreeBSD, Linux, or Mac using `libc++abi`_ as the C++ ABI library.
On Linux, it is also possible to use :ref:`libsupc++ <libsupcxx>` or libcxxrt.
-It is sometimes beneficial to build outside of the LLVM tree. An out-of-tree
-build would look like this:
+It is sometimes beneficial to build separately from the full LLVM build. An
+out-of-tree build would look like this:
.. code-block:: bash
$ cd where-you-want-libcxx-to-live
- $ # Check out llvm, libc++ and libc++abi.
- $ ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
- $ ``svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx``
- $ ``svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi``
+ $ # Check out the sources (includes everything, but we'll only use libcxx)
+ $ ``git clone https://github.com/llvm/llvm-project.git``
$ cd where-you-want-to-build
$ mkdir build && cd build
$ export CC=clang CXX=clang++
- $ cmake -DLLVM_PATH=path/to/llvm \
+ $ cmake -DLLVM_PATH=path/to/separate/llvm \
-DLIBCXX_CXX_ABI=libcxxabi \
- -DLIBCXX_CXX_ABI_INCLUDE_PATHS=path/to/libcxxabi/include \
- path/to/libcxx
+ -DLIBCXX_CXX_ABI_INCLUDE_PATHS=path/to/separate/libcxxabi/include \
+ path/to/llvm-project/libcxx
$ make
$ make check-libcxx # optional
diff --git a/docs/index.rst b/docs/index.rst
index fddf74b..80c2a8d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -190,5 +190,4 @@
* `LLVM Bugzilla <https://bugs.llvm.org/>`_
* `libcxx-commits Mailing List`_
* `libcxx-dev Mailing List`_
-* `Browse libc++ -- SVN <http://llvm.org/svn/llvm-project/libcxx/trunk/>`_
-* `Browse libc++ -- ViewVC <http://llvm.org/viewvc/llvm-project/libcxx/trunk/>`_
+* `Browse libc++ Sources <https://github.com/llvm/llvm-project/tree/master/libcxx/>`_