[lld] r352514 - Adjust documentation for git migration.

James Y Knight via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 29 08:37:28 PST 2019


Author: jyknight
Date: Tue Jan 29 08:37:27 2019
New Revision: 352514

URL: http://llvm.org/viewvc/llvm-project?rev=352514&view=rev
Log:
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

Modified:
    lld/trunk/docs/getting_started.rst
    lld/trunk/docs/index.rst

Modified: lld/trunk/docs/getting_started.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/getting_started.rst?rev=352514&r1=352513&r2=352514&view=diff
==============================================================================
--- lld/trunk/docs/getting_started.rst (original)
+++ lld/trunk/docs/getting_started.rst Tue Jan 29 08:37:27 2019
@@ -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
 

Modified: lld/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/index.rst?rev=352514&r1=352513&r2=352514&view=diff
==============================================================================
--- lld/trunk/docs/index.rst (original)
+++ lld/trunk/docs/index.rst Tue Jan 29 08:37:27 2019
@@ -106,7 +106,7 @@ build that tree. You need `cmake` and of
 
 .. 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




More information about the llvm-commits mailing list