diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst index f49b5b13378ea2..378695d3de8866 100644 --- a/llvm/docs/DeveloperPolicy.rst +++ b/llvm/docs/DeveloperPolicy.rst @@ -89,8 +89,7 @@ to read it as possible. As such, we recommend that you: #. Make your patch against git main, not a branch, and not an old version of LLVM. This makes it easy to apply the patch. For information on how to - clone from git, please see the :ref:`Getting Started Guide - `. + clone from git, please see the :ref:`Getting Started Guide `. #. Similarly, patches should be submitted soon after they are generated. Old patches may not apply correctly if the underlying code changes between the diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index da9cc8aea6d32d..e70fded24d9eac 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/docs/GettingStarted.rst @@ -24,6 +24,8 @@ Other components include: the `libc++ C++ standard library `_, the `LLD linker `_, and more. +.. _sources: + Getting the Source Code and Building LLVM ========================================= @@ -505,60 +507,6 @@ appropriate pathname on your local system. All these paths are absolute: object files and compiled programs will be placed. It can be the same as SRC_ROOT). -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 number of different -subprojects. Each one has its own download which is a TAR archive that is -compressed with 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. - -``cfe-x.y.tar.gz`` - - Source release for the Clang frontend. - -.. _checkout: - -Checkout LLVM from Git ----------------------- - -You can also checkout the source code for LLVM from Git. - -.. 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 ^^^^^^^^^^^^^^^