summaryrefslogtreecommitdiffstats
path: root/lld
diff options
context:
space:
mode:
authorJames Y Knight <jyknight@google.com>2019-01-29 16:37:27 +0000
committerJames Y Knight <jyknight@google.com>2019-01-29 16:37:27 +0000
commit5d71fc5d7b5ffe2323418a09db6eddaf84d6c662 (patch)
tree3354c257cd3b01f4a1a928017e9258238311b887 /lld
parent6409d756989033a7410c33e061debe55cfd74133 (diff)
downloadbcm5719-llvm-5d71fc5d7b5ffe2323418a09db6eddaf84d6c662.tar.gz
bcm5719-llvm-5d71fc5d7b5ffe2323418a09db6eddaf84d6c662.zip
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
Diffstat (limited to 'lld')
-rw-r--r--lld/docs/getting_started.rst35
-rw-r--r--lld/docs/index.rst2
2 files changed, 9 insertions, 28 deletions
diff --git a/lld/docs/getting_started.rst b/lld/docs/getting_started.rst
index 97c3d1bccbd..a174f652e73 100644
--- a/lld/docs/getting_started.rst
+++ b/lld/docs/getting_started.rst
@@ -28,23 +28,15 @@ On Unix-like Systems
.. _libc++: http://libcxx.llvm.org/
.. _Python 2.4: http://python.org/download/
-2. Check out LLVM::
+2. Check out LLVM and subprojects (including lld)::
- $ cd path/to/llvm-project
- $ svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm
-
-3. Check out lld::
-
- $ cd llvm/tools
- $ svn co http://llvm.org/svn/llvm-project/lld/trunk lld
-
- * lld can also be checked out to ``path/to/llvm-project`` and built as an external
- project.
+ $ git clone https://github.com/llvm/llvm-project.git
4. Build LLVM and lld::
- $ cd path/to/llvm-build/llvm (out of source build required)
- $ cmake -G "Unix Makefiles" path/to/llvm-project/llvm
+ $ cd llvm-project
+ $ mkdir build && cd build
+ $ cmake -G "Unix Makefiles" -DLLVM_ENABLE_PROJECTS=lld ../llvm
$ make
* If you want to build with clang and it is not the default compiler or
@@ -71,23 +63,12 @@ Using Visual Studio
.. _Visual Studio 12 (2013) or later: http://www.microsoft.com/visualstudio/11/en-us
.. _Python 2.4: http://python.org/download/
-#. Check out LLVM::
-
- $ cd path/to/llvm-project
- $ svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm
-
-#. Check out lld::
-
- $ cd llvm/tools
- $ svn co http://llvm.org/svn/llvm-project/lld/trunk lld
-
- * lld can also be checked out to ``path/to/llvm-project`` and built as an external
- project.
+#. Check out LLVM as above.
#. Generate Visual Studio project files::
- $ cd path/to/llvm-build/llvm (out of source build required)
- $ cmake -G "Visual Studio 11" path/to/llvm-project/llvm
+ $ cd llvm-project/build (out of source build required)
+ $ cmake -G "Visual Studio 11" -DLLVM_ENABLE_PROJECTS=lld ../llvm
#. Build
diff --git a/lld/docs/index.rst b/lld/docs/index.rst
index da1c894f3d8..db8ea1cd53a 100644
--- a/lld/docs/index.rst
+++ b/lld/docs/index.rst
@@ -106,7 +106,7 @@ build that tree. You need `cmake` and of course a C++ compiler.
.. code-block:: console
- $ git clone https://github.com/llvm-project/llvm-project-20170507 llvm-project
+ $ git clone https://github.com/llvm/llvm-project llvm-project
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS=lld -DCMAKE_INSTALL_PREFIX=/usr/local ../llvm-project/llvm
OpenPOWER on IntegriCloud