[llvm] d5e8a27 - [docs] Remove second "getting sources" section in GettingStarted.rst (#79663)

via llvm-commits llvm-commits at lists.llvm.org
Mon Jan 29 10:17:03 PST 2024


Author: Arthur Eubanks
Date: 2024-01-29T10:16:58-08:00
New Revision: d5e8a273fddcf4abbfc59d16f08e735f7cefff93

URL: https://github.com/llvm/llvm-project/commit/d5e8a273fddcf4abbfc59d16f08e735f7cefff93
DIFF: https://github.com/llvm/llvm-project/commit/d5e8a273fddcf4abbfc59d16f08e735f7cefff93.diff

LOG: [docs] Remove second "getting sources" section in GettingStarted.rst (#79663)

The very beginning already talks about how to git clone the repo. The
section about checking out specific versions doesn't really belong in
GettingStarted and seems unnecessary.

Added: 
    

Modified: 
    llvm/docs/DeveloperPolicy.rst
    llvm/docs/GettingStarted.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index d383de58da55a7..19b8ddb5245fc3 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -91,8 +91,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
-   <checkout>`.
+   clone from git, please see the :ref:`Getting Started Guide <sources>`.
 
 #. 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 98d47c945aeee7..316fc6ad86b848 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -24,6 +24,8 @@ Other components include:
 the `libc++ C++ standard library <https://libcxx.llvm.org>`_,
 the `LLD linker <https://lld.llvm.org>`_, and more.
 
+.. _sources:
+
 Getting the Source Code and Building LLVM
 =========================================
 
@@ -507,60 +509,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 
diff erent
-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
 ^^^^^^^^^^^^^^^
 


        


More information about the llvm-commits mailing list