diff options
author | James Y Knight <jyknight@google.com> | 2019-01-29 16:37:27 +0000 |
---|---|---|
committer | James Y Knight <jyknight@google.com> | 2019-01-29 16:37:27 +0000 |
commit | e0324cb307cc5dd2974faa3e0f2d8693c0aec9a0 (patch) | |
tree | 78225fe277eba03ba5070d62573bffd893096b2b | |
parent | b8bdc7a1574cbb5ba6ef9754e6b96bcf6d96b3dd (diff) | |
download | libcxx-e0324cb307cc5dd2974faa3e0f2d8693c0aec9a0.tar.gz |
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
git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@352514 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r-- | docs/BuildingLibcxx.rst | 47 | ||||
-rw-r--r-- | docs/index.rst | 3 | ||||
-rw-r--r-- | www/TS_deprecation.html | 3 | ||||
-rw-r--r-- | www/atomic_design.html | 3 | ||||
-rw-r--r-- | www/atomic_design_a.html | 3 | ||||
-rw-r--r-- | www/atomic_design_b.html | 3 | ||||
-rw-r--r-- | www/atomic_design_c.html | 3 | ||||
-rw-r--r-- | www/cxx1y_status.html | 3 | ||||
-rw-r--r-- | www/cxx1z_status.html | 3 | ||||
-rw-r--r-- | www/cxx2a_status.html | 3 | ||||
-rw-r--r-- | www/index.html | 3 | ||||
-rw-r--r-- | www/ts1z_status.html | 3 | ||||
-rw-r--r-- | www/type_traits_design.html | 3 | ||||
-rw-r--r-- | www/upcoming_meeting.html | 3 |
14 files changed, 24 insertions, 62 deletions
diff --git a/docs/BuildingLibcxx.rst b/docs/BuildingLibcxx.rst index a498c0027..01f442de3 100644 --- a/docs/BuildingLibcxx.rst +++ b/docs/BuildingLibcxx.rst @@ -18,33 +18,10 @@ Xcode 4.2 or later. However if you want to install tip-of-trunk from here 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 @@ The instructions are for building libc++ on 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 fddf74b66..80c2a8ddd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -190,5 +190,4 @@ Quick Links * `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/>`_ diff --git a/www/TS_deprecation.html b/www/TS_deprecation.html index a8dd8c183..f3c002fe4 100644 --- a/www/TS_deprecation.html +++ b/www/TS_deprecation.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/atomic_design.html b/www/atomic_design.html index 1c6627aad..30fb6feeb 100644 --- a/www/atomic_design.html +++ b/www/atomic_design.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/atomic_design_a.html b/www/atomic_design_a.html index 589ca83c1..d3e687f0d 100644 --- a/www/atomic_design_a.html +++ b/www/atomic_design_a.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/atomic_design_b.html b/www/atomic_design_b.html index 7f81f8b7c..e07eb8698 100644 --- a/www/atomic_design_b.html +++ b/www/atomic_design_b.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/atomic_design_c.html b/www/atomic_design_c.html index 82cc80f7f..936ee6588 100644 --- a/www/atomic_design_c.html +++ b/www/atomic_design_c.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/cxx1y_status.html b/www/cxx1y_status.html index 0af6352e9..7c62dc5ec 100644 --- a/www/cxx1y_status.html +++ b/www/cxx1y_status.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/cxx1z_status.html b/www/cxx1z_status.html index c2c6f7b02..823c37b58 100644 --- a/www/cxx1z_status.html +++ b/www/cxx1z_status.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/cxx2a_status.html b/www/cxx2a_status.html index a5e87ec18..36bc659c9 100644 --- a/www/cxx2a_status.html +++ b/www/cxx2a_status.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/index.html b/www/index.html index 3724b8b43..c707bc18b 100644 --- a/www/index.html +++ b/www/index.html @@ -26,8 +26,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/libcxx-dev">libcxx-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/libcxx-commits">libcxx-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/ts1z_status.html b/www/ts1z_status.html index 22ad0d450..1c2e3a244 100644 --- a/www/ts1z_status.html +++ b/www/ts1z_status.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/type_traits_design.html b/www/type_traits_design.html index 1cab2936d..3b3355f2f 100644 --- a/www/type_traits_design.html +++ b/www/type_traits_design.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> diff --git a/www/upcoming_meeting.html b/www/upcoming_meeting.html index f99ff14dd..801a92b22 100644 --- a/www/upcoming_meeting.html +++ b/www/upcoming_meeting.html @@ -25,8 +25,7 @@ <a href="https://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> <a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a> <a href="https://bugs.llvm.org/">Bug Reports</a> - <a href="https://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a> - <a href="https://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a> + <a href="https://github.com/llvm/llvm-project/tree/master/libcxx/">Browse Sources</a> </div> </div> |