Skip to content

Commit d5e8a27

Browse files
authored
[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.
1 parent 7b0396f commit d5e8a27

File tree

2 files changed

+3
-56
lines changed

2 files changed

+3
-56
lines changed

llvm/docs/DeveloperPolicy.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,7 @@ to read it as possible. As such, we recommend that you:
9191

9292
#. Make your patch against git main, not a branch, and not an old version
9393
of LLVM. This makes it easy to apply the patch. For information on how to
94-
clone from git, please see the :ref:`Getting Started Guide
95-
<checkout>`.
94+
clone from git, please see the :ref:`Getting Started Guide <sources>`.
9695

9796
#. Similarly, patches should be submitted soon after they are generated. Old
9897
patches may not apply correctly if the underlying code changes between the

llvm/docs/GettingStarted.rst

Lines changed: 2 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Other components include:
2424
the `libc++ C++ standard library <https://libcxx.llvm.org>`_,
2525
the `LLD linker <https://lld.llvm.org>`_, and more.
2626

27+
.. _sources:
28+
2729
Getting the Source Code and Building LLVM
2830
=========================================
2931

@@ -507,60 +509,6 @@ appropriate pathname on your local system. All these paths are absolute:
507509
object files and compiled programs will be placed. It can be the same as
508510
SRC_ROOT).
509511

510-
Unpacking the LLVM Archives
511-
---------------------------
512-
513-
If you have the LLVM distribution, you will need to unpack it before you can
514-
begin to compile it. LLVM is distributed as a number of different
515-
subprojects. Each one has its own download which is a TAR archive that is
516-
compressed with the gzip program.
517-
518-
The files are as follows, with *x.y* marking the version number:
519-
520-
``llvm-x.y.tar.gz``
521-
522-
Source release for the LLVM libraries and tools.
523-
524-
``cfe-x.y.tar.gz``
525-
526-
Source release for the Clang frontend.
527-
528-
.. _checkout:
529-
530-
Checkout LLVM from Git
531-
----------------------
532-
533-
You can also checkout the source code for LLVM from Git.
534-
535-
.. note::
536-
537-
Passing ``--config core.autocrlf=false`` should not be required in
538-
the future after we adjust the .gitattribute settings correctly, but
539-
is required for Windows users at the time of this writing.
540-
541-
Simply run:
542-
543-
.. code-block:: console
544-
545-
% git clone https://github.com/llvm/llvm-project.git
546-
547-
or on Windows,
548-
549-
.. code-block:: console
550-
551-
% git clone --config core.autocrlf=false https://github.com/llvm/llvm-project.git
552-
553-
This will create an '``llvm-project``' directory in the current directory and
554-
fully populate it with all of the source code, test directories, and local
555-
copies of documentation files for LLVM and all the related subprojects. Note
556-
that unlike the tarballs, which contain each subproject in a separate file, the
557-
git repository contains all of the projects together.
558-
559-
If you want to get a specific release (as opposed to the most recent revision),
560-
you can check out a tag after cloning the repository. E.g., `git checkout
561-
llvmorg-6.0.1` inside the ``llvm-project`` directory created by the above
562-
command. Use `git tag -l` to list all of them.
563-
564512
Sending patches
565513
^^^^^^^^^^^^^^^
566514

0 commit comments

Comments
 (0)