Skip to content

Commit 5d71fc5

Browse files
committed
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
1 parent 6409d75 commit 5d71fc5

File tree

68 files changed

+202
-498
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+202
-498
lines changed

clang-tools-extra/docs/clang-rename.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ Vim Integration
139139

140140
You can call :program:`clang-rename` directly from Vim! To set up
141141
:program:`clang-rename` integration for Vim see
142-
`clang-rename/tool/clang-rename.py
143-
<https://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.py>`_.
142+
`clang/tools/clang-rename/clang-rename.py
143+
<https://github.com/llvm/llvm-project/blob/master/clang/tools/clang-rename/clang-rename.py>`_.
144144

145145
Please note that **you have to save all buffers, in which the replacement will
146146
happen before running the tool**.
@@ -157,7 +157,7 @@ Emacs Integration
157157
You can also use :program:`clang-rename` while using Emacs! To set up
158158
:program:`clang-rename` integration for Emacs see
159159
`clang-rename/tool/clang-rename.el
160-
<https://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.el>`_.
160+
<https://github.com/llvm/llvm-project/blob/master/clang/tools/clang-rename/clang-rename.el>`_.
161161

162162
Once installed, you can point your cursor to symbols you want to rename, press
163163
`M-X`, type `clang-rename` and new desired name.

clang-tools-extra/docs/clang-tidy/Contributing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ style used in the project. For code reviews we mostly use `LLVM Phabricator`_.
127127

128128
Next, you need to decide which module the check belongs to. Modules
129129
are located in subdirectories of `clang-tidy/
130-
<https://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/>`_
130+
<https://github.com/llvm/llvm-project/tree/master/clang-tools-extra/clang-tidy/>`_
131131
and contain checks targeting a certain aspect of code quality (performance,
132132
readability, etc.), certain coding style or standard (Google, LLVM, CERT, etc.)
133133
or a widely used API (e.g. MPI). Their names are same as user-facing check
@@ -210,7 +210,7 @@ can further inspect them and report diagnostics.
210210
211211
(If you want to see an example of a useful check, look at
212212
`clang-tidy/google/ExplicitConstructorCheck.h
213-
<https://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/google/ExplicitConstructorCheck.h>`_
213+
<https://github.com/llvm/llvm-project/blob/master/clang-tools-extra/clang-tidy/google/ExplicitConstructorCheck.h>`_
214214
and `clang-tidy/google/ExplicitConstructorCheck.cpp
215215
<https://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/google/ExplicitConstructorCheck.cpp>`_).
216216

clang-tools-extra/docs/clang-tidy/Integrations.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ choose the checks to be performed in the Clang Code Model Warnings menu.
7575
.. _ReSharper C++: https://www.jetbrains.com/help/resharper/Clang_Tidy_Integration.html
7676
.. _Visual Assist: https://docs.wholetomato.com/default.asp?W761
7777
.. _Clang Power Tools: https://marketplace.visualstudio.com/items?itemName=caphyon.ClangPowerTools
78-
.. _clang-tidy-vs: https://github.com/llvm-mirror/clang-tools-extra/tree/master/clang-tidy-vs
78+
.. _clang-tidy-vs: https://github.com/llvm/llvm-project/tree/master/clang-tools-extra/clang-tidy-vs
7979

8080
`MS Visual Studio`_ has a native clang-tidy-vs_ plugin and also can integrate
8181
:program:`clang-tidy` by means of three other tools. The `ReSharper C++`_

clang/.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
#==============================================================================#
22
# This file specifies intentionally untracked files that git should ignore.
33
# See: http://www.kernel.org/pub/software/scm/git/docs/gitignore.html
4-
#
5-
# This file is intentionally different from the output of `git svn show-ignore`,
6-
# as most of those are useless.
74
#==============================================================================#
85

96
#==============================================================================#

clang/docs/ClangPlugins.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Putting it all together
6969
Let's look at an example plugin that prints top-level function names. This
7070
example is checked into the clang repository; please take a look at
7171
the `latest version of PrintFunctionNames.cpp
72-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/examples/PrintFunctionNames/PrintFunctionNames.cpp?view=markup>`_.
72+
<https://github.com/llvm/llvm-project/blob/master/clang/examples/PrintFunctionNames/PrintFunctionNames.cpp>`_.
7373

7474
Running the plugin
7575
==================
@@ -110,7 +110,7 @@ source tree:
110110
-plugin -Xclang print-fns
111111
112112
Also see the print-function-name plugin example's
113-
`README <https://llvm.org/viewvc/llvm-project/cfe/trunk/examples/PrintFunctionNames/README.txt?view=markup>`_
113+
`README <https://github.com/llvm/llvm-project/blob/master/clang/examples/PrintFunctionNames/README.txt>`_
114114

115115

116116
Using the clang command line

clang/docs/ClangTools.rst

+3-16
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,9 @@ functionality such as fast syntax checking, automatic formatting,
99
refactoring, etc.
1010

1111
Only a couple of the most basic and fundamental tools are kept in the
12-
primary Clang Subversion project. The rest of the tools are kept in a
13-
side-project so that developers who don't want or need to build them
14-
don't. If you want to get access to the extra Clang Tools repository,
15-
simply check it out into the tools tree of your Clang checkout and
16-
follow the usual process for building and working with a combined
17-
LLVM/Clang checkout:
18-
19-
- With Subversion:
20-
21-
- ``cd llvm/tools/clang/tools``
22-
- ``svn co https://llvm.org/svn/llvm-project/clang-tools-extra/trunk extra``
23-
24-
- Or with Git:
25-
26-
- ``cd llvm/tools/clang/tools``
27-
- ``git clone https://llvm.org/git/clang-tools-extra.git extra``
12+
primary Clang tree. The rest of the tools are kept in a separate
13+
directory tree, ``clang-tools-extra
14+
<https://github.com/llvm/llvm-project/tree/master/clang-tools-extra>``_.
2815
2916
This document describes a high-level overview of the organization of
3017
Clang Tools within the project as well as giving an introduction to some

clang/docs/ControlFlowIntegrityDesign.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ those sub-hierarchies need to be (see "Stripping Leading/Trailing Zeros in Bit
196196
Vectors" above). The `GlobalLayoutBuilder`_ class is responsible for laying
197197
out the globals efficiently to minimize the sizes of the underlying bitsets.
198198

199-
.. _GlobalLayoutBuilder: https://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Transforms/IPO/LowerTypeTests.h?view=markup
199+
.. _GlobalLayoutBuilder: https://github.com/llvm/llvm-project/blob/master/llvm/include/llvm/Transforms/IPO/LowerTypeTests.h
200200

201201
Alignment
202202
~~~~~~~~~
@@ -300,7 +300,7 @@ The interleaving scheme, however, can only work with individual virtual tables s
300300
In comparison, the old scheme does not require the splitting but it is more efficient when the combined virtual tables have been split.
301301
The `GlobalSplit`_ pass is responsible for splitting combined virtual tables into individual ones.
302302

303-
.. _GlobalSplit: https://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Transforms/IPO/GlobalSplit.cpp?view=markup
303+
.. _GlobalSplit: https://github.com/llvm/llvm-project/blob/master/llvm/lib/Transforms/IPO/GlobalSplit.cpp
304304

305305
Order virtual tables by a pre-order traversal of the class hierarchy
306306
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

clang/docs/InternalsManual.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -1686,7 +1686,7 @@ semantic checking for some attributes, etc.
16861686
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16871687
The first step to adding a new attribute to Clang is to add its definition to
16881688
`include/clang/Basic/Attr.td
1689-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/Attr.td?view=markup>`_.
1689+
<https://github.com/llvm/llvm-project/blob/master/clang/include/clang/Basic/Attr.td>`_.
16901690
This tablegen definition must derive from the ``Attr`` (tablegen, not
16911691
semantic) type, or one of its derivatives. Most attributes will derive from the
16921692
``InheritableAttr`` type, which specifies that the attribute can be inherited by
@@ -1748,10 +1748,10 @@ the ``SubjectList``. The diagnostics generated for subject list violations are
17481748
either ``diag::warn_attribute_wrong_decl_type`` or
17491749
``diag::err_attribute_wrong_decl_type``, and the parameter enumeration is found
17501750
in `include/clang/Sema/ParsedAttr.h
1751-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Sema/ParsedAttr.h?view=markup>`_
1751+
<https://github.com/llvm/llvm-project/blob/master/clang/include/clang/Sema/ParsedAttr.h>`_
17521752
If a previously unused Decl node is added to the ``SubjectList``, the logic used
17531753
to automatically determine the diagnostic parameter in `utils/TableGen/ClangAttrEmitter.cpp
1754-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/utils/TableGen/ClangAttrEmitter.cpp?view=markup>`_
1754+
<https://github.com/llvm/llvm-project/blob/master/clang/utils/TableGen/ClangAttrEmitter.cpp>`_
17551755
may need to be updated.
17561756

17571757
By default, all subjects in the SubjectList must either be a Decl node defined
@@ -1773,7 +1773,7 @@ All attributes must have some form of documentation associated with them.
17731773
Documentation is table generated on the public web server by a server-side
17741774
process that runs daily. Generally, the documentation for an attribute is a
17751775
stand-alone definition in `include/clang/Basic/AttrDocs.td
1776-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/AttdDocs.td?view=markup>`_
1776+
<https://github.com/llvm/llvm-project/blob/master/clang/include/clang/Basic/AttrDocs.td>`_
17771777
that is named after the attribute being documented.
17781778

17791779
If the attribute is not for public consumption, or is an implicitly-created
@@ -1824,7 +1824,7 @@ All arguments have a name and a flag that specifies whether the argument is
18241824
optional. The associated C++ type of the argument is determined by the argument
18251825
definition type. If the existing argument types are insufficient, new types can
18261826
be created, but it requires modifying `utils/TableGen/ClangAttrEmitter.cpp
1827-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/utils/TableGen/ClangAttrEmitter.cpp?view=markup>`_
1827+
<https://github.com/llvm/llvm-project/blob/master/clang/utils/TableGen/ClangAttrEmitter.cpp>`_
18281828
to properly support the type.
18291829

18301830
Other Properties
@@ -1836,7 +1836,7 @@ document, however a few deserve mention.
18361836
If the parsed form of the attribute is more complex, or differs from the
18371837
semantic form, the ``HasCustomParsing`` bit can be set to ``1`` for the class,
18381838
and the parsing code in `Parser::ParseGNUAttributeArgs()
1839-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Parse/ParseDecl.cpp?view=markup>`_
1839+
<https://github.com/llvm/llvm-project/blob/master/clang/lib/Parse/ParseDecl.cpp>`_
18401840
can be updated for the special case. Note that this only applies to arguments
18411841
with a GNU spelling -- attributes with a __declspec spelling currently ignore
18421842
this flag and are handled by ``Parser::ParseMicrosoftDeclSpec``.
@@ -1899,7 +1899,7 @@ semantic attribute class object, with ``public`` access.
18991899
Boilerplate
19001900
^^^^^^^^^^^
19011901
All semantic processing of declaration attributes happens in `lib/Sema/SemaDeclAttr.cpp
1902-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Sema/SemaDeclAttr.cpp?view=markup>`_,
1902+
<https://github.com/llvm/llvm-project/blob/master/clang/lib/Sema/SemaDeclAttr.cpp>`_,
19031903
and generally starts in the ``ProcessDeclAttribute()`` function. If the
19041904
attribute is a "simple" attribute -- meaning that it requires no custom semantic
19051905
processing aside from what is automatically provided, add a call to
@@ -1915,11 +1915,11 @@ correct minimum number of arguments are passed, etc.
19151915

19161916
If the attribute adds additional warnings, define a ``DiagGroup`` in
19171917
`include/clang/Basic/DiagnosticGroups.td
1918-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/DiagnosticGroups.td?view=markup>`_
1918+
<https://github.com/llvm/llvm-project/blob/master/clang/include/clang/Basic/DiagnosticGroups.td>`_
19191919
named after the attribute's ``Spelling`` with "_"s replaced by "-"s. If there
19201920
is only a single diagnostic, it is permissible to use ``InGroup<DiagGroup<"your-attribute">>``
19211921
directly in `DiagnosticSemaKinds.td
1922-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/DiagnosticSemaKinds.td?view=markup>`_
1922+
<https://github.com/llvm/llvm-project/blob/master/clang/include/clang/Basic/DiagnosticSemaKinds.td>`_
19231923

19241924
All semantic diagnostics generated for your attribute, including automatically-
19251925
generated ones (such as subjects and argument counts), should have a

clang/docs/LibASTMatchersTutorial.rst

+8-17
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,16 @@ Step 0: Obtaining Clang
1616
=======================
1717

1818
As Clang is part of the LLVM project, you'll need to download LLVM's
19-
source code first. Both Clang and LLVM are maintained as Subversion
20-
repositories, but we'll be accessing them through the git mirror. For
21-
further information, see the `getting started
22-
guide <https://llvm.org/docs/GettingStarted.html>`_.
19+
source code first. Both Clang and LLVM are in the same git repository,
20+
under different directories. For further information, see the `getting
21+
started guide <https://llvm.org/docs/GettingStarted.html>`_.
2322

2423
.. code-block:: console
2524
26-
mkdir ~/clang-llvm && cd ~/clang-llvm
27-
git clone https://llvm.org/git/llvm.git
28-
cd llvm/tools
29-
git clone https://llvm.org/git/clang.git
30-
cd clang/tools
31-
git clone https://llvm.org/git/clang-tools-extra.git extra
25+
cd ~/clang-llvm
26+
git clone https://github.com/llvm/llvm-project.git
3227
33-
Next you need to obtain the CMake build system and Ninja build tool. You
34-
may already have CMake installed, but current binary versions of CMake
35-
aren't built with Ninja support.
28+
Next you need to obtain the CMake build system and Ninja build tool.
3629

3730
.. code-block:: console
3831
@@ -57,17 +50,15 @@ Okay. Now we'll build Clang!
5750
5851
cd ~/clang-llvm
5952
mkdir build && cd build
60-
cmake -G Ninja ../llvm -DLLVM_BUILD_TESTS=ON # Enable tests; default is off.
53+
cmake -G Ninja ../llvm -DLLVM_ENABLE_PROJECTS=clang -DLLVM_BUILD_TESTS=ON # Enable tests; default is off.
6154
ninja
6255
ninja check # Test LLVM only.
6356
ninja clang-test # Test Clang only.
6457
ninja install
6558
6659
And we're live.
6760

68-
All of the tests should pass, though there is a (very) small chance that
69-
you can catch LLVM and Clang out of sync. Running ``'git svn rebase'``
70-
in both the llvm and clang directories should fix any problems.
61+
All of the tests should pass.
7162

7263
Finally, we want to set Clang as its own compiler.
7364

clang/docs/LibTooling.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,6 @@ with ``-v`` and look at the search paths it looks through.
196196
Linking
197197
^^^^^^^
198198

199-
For a list of libraries to link, look at one of the tools' Makefiles (for
200-
example `clang-check/Makefile
201-
<https://llvm.org/viewvc/llvm-project/cfe/trunk/tools/clang-check/Makefile?view=markup>`_).
199+
For a list of libraries to link, look at one of the tools' CMake files (for
200+
example `clang-check/CMakeList.txt
201+
<https://github.com/llvm/llvm-project/blob/master/clang/tools/clang-check/CMakeLists.txt>`_).

clang/docs/Toolchain.rst

+2-8
Original file line numberDiff line numberDiff line change
@@ -229,14 +229,8 @@ of other runtimes.
229229
libunwind (LLVM)
230230
^^^^^^^^^^^^^^^^
231231

232-
LLVM's unwinder library can be obtained from subversion:
233-
234-
.. code-block:: console
235-
236-
llvm-src$ svn co https://llvm.org/svn/llvm-project/libunwind/trunk projects/libunwind
237-
238-
When checked out into projects/libunwind within an LLVM checkout,
239-
it should be automatically picked up by the LLVM build system.
232+
LLVM's unwinder library is part of the llvm-project git repository. To
233+
build it, pass ``-DLLVM_ENABLE_PROJECTS=libunwind`` to the cmake invocation.
240234

241235
If using libc++abi, you may need to configure it to use libunwind
242236
rather than libgcc_s by passing ``-DLIBCXXABI_USE_LLVM_UNWINDER=YES``

clang/lib/CodeGen/CGOpenMPRuntime.cpp

+4-5
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ class InlinedOpenMPRegionRAII {
431431

432432
/// Values for bit flags used in the ident_t to describe the fields.
433433
/// All enumeric elements are named and described in accordance with the code
434-
/// from http://llvm.org/svn/llvm-project/openmp/trunk/runtime/src/kmp.h
434+
/// from https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp.h
435435
enum OpenMPLocationFlags : unsigned {
436436
/// Use trampoline for internal microtask.
437437
OMP_IDENT_IMD = 0x01,
@@ -460,7 +460,7 @@ enum OpenMPLocationFlags : unsigned {
460460

461461
/// Describes ident structure that describes a source location.
462462
/// All descriptions are taken from
463-
/// http://llvm.org/svn/llvm-project/openmp/trunk/runtime/src/kmp.h
463+
/// https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp.h
464464
/// Original structure:
465465
/// typedef struct ident {
466466
/// kmp_int32 reserved_1; /**< might be used in Fortran;
@@ -1477,7 +1477,7 @@ Address CGOpenMPRuntime::getOrCreateDefaultLocation(unsigned Flags) {
14771477
// Initialize default location for psource field of ident_t structure of
14781478
// all ident_t objects. Format is ";file;function;line;column;;".
14791479
// Taken from
1480-
// http://llvm.org/svn/llvm-project/openmp/trunk/runtime/src/kmp_str.c
1480+
// https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp_str.cpp
14811481
DefaultOpenMPPSource =
14821482
CGM.GetAddrOfConstantCString(";unknown;unknown;0;0;;").getPointer();
14831483
DefaultOpenMPPSource =
@@ -4965,7 +4965,7 @@ CGOpenMPRuntime::emitTaskInit(CodeGenFunction &CGF, SourceLocation Loc,
49654965
// kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
49664966
// kmp_routine_entry_t *task_entry);
49674967
// Task flags. Format is taken from
4968-
// http://llvm.org/svn/llvm-project/openmp/trunk/runtime/src/kmp.h,
4968+
// https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp.h,
49694969
// description of kmp_tasking_flags struct.
49704970
enum {
49714971
TiedFlag = 0x1,
@@ -9888,4 +9888,3 @@ CGOpenMPSIMDRuntime::getParameterAddress(CodeGenFunction &CGF,
98889888
const VarDecl *TargetParam) const {
98899889
llvm_unreachable("Not supported in SIMD-only mode");
98909890
}
9891-

clang/www/analyzer/checker_dev_manual.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -789,11 +789,11 @@ <h2 id=additioninformation>Additional Sources of Information</h2>
789789
<li><a href="http://lcs.ios.ac.cn/~xuzb/canalyze/memmodel.pdf">Xu, Zhongxing &
790790
Kremenek, Ted & Zhang, Jian. (2010). A Memory Model for Static Analysis of C
791791
Programs.</a></li>
792-
<li><a href="https://github.com/llvm-mirror/clang/blob/master/lib/StaticAnalyzer/README.txt">
792+
<li><a href="https://github.com/llvm/llvm-project/blob/master/clang/lib/StaticAnalyzer/README.txt">
793793
The Clang Static Analyzer README</a></li>
794-
<li><a href="https://github.com/llvm-mirror/clang/blob/master/docs/analyzer/RegionStore.txt">
794+
<li><a href="https://github.com/llvm/llvm-project/blob/master/clang/docs/analyzer/RegionStore.txt">
795795
Documentation for how the Store works</a></li>
796-
<li><a href="https://github.com/llvm-mirror/clang/blob/master/docs/analyzer/IPA.txt">
796+
<li><a href="https://github.com/llvm/llvm-project/blob/master/clang/docs/analyzer/IPA.txt">
797797
Documentation about inlining</a></li>
798798
<li> The "Building a Checker in 24 hours" presentation given at the <a
799799
href="http://llvm.org/devmtg/2012-11">November 2012 LLVM Developer's

0 commit comments

Comments
 (0)