From 43def795aacd6794f93b91fc76e59953fd67e138 Mon Sep 17 00:00:00 2001 From: Hafiz Abid Qadeer Date: Mon, 21 Dec 2020 19:06:17 +0000 Subject: [PATCH] Update references to 'master' branch. This commit replace 'master' with 'main' in llvm/docs. Reviewed By: sammccall, kristof.beyls Differential Revision: https://reviews.llvm.org/D92831 --- llvm/docs/CodingStandards.rst | 2 +- llvm/docs/DeveloperPolicy.rst | 4 ++-- llvm/docs/FAQ.rst | 2 +- llvm/docs/GettingStarted.rst | 10 +++++----- llvm/docs/GitBisecting.rst | 6 +++--- llvm/docs/GlobalISel/IRTranslator.rst | 2 +- llvm/docs/LibFuzzer.rst | 4 ++-- llvm/docs/TestingGuide.rst | 2 +- llvm/docs/TypeMetadata.rst | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.rst index a5798bd73cb1..57d148df89f8 100644 --- a/llvm/docs/CodingStandards.rst +++ b/llvm/docs/CodingStandards.rst @@ -77,7 +77,7 @@ on the standard library facilities and the LLVM support libraries as much as possible. LLVM support libraries (for example, `ADT -`_) +`_) implement specialized data structures or functionality missing in the standard library. Such libraries are usually implemented in the ``llvm`` namespace and follow the expected standard interface, when there is one. diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst index 3fa629965318..7bcb5664540a 100644 --- a/llvm/docs/DeveloperPolicy.rst +++ b/llvm/docs/DeveloperPolicy.rst @@ -80,7 +80,7 @@ Making and Submitting a Patch When making a patch for review, the goal is to make it as easy for the reviewer to read it as possible. As such, we recommend that you: -#. Make your patch against git master, not a branch, and not an old version +#. 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 `. @@ -146,7 +146,7 @@ problem, we have a notion of an 'owner' for a piece of the code. The sole responsibility of a code owner is to ensure that a commit to their area of the code is appropriately reviewed, either by themself or by someone else. The list of current code owners can be found in the file `CODE_OWNERS.TXT -`_ in the +`_ in the root of the LLVM source tree. Note that code ownership is completely different than reviewers: anyone can diff --git a/llvm/docs/FAQ.rst b/llvm/docs/FAQ.rst index aef15d6dc711..229ac99f703c 100644 --- a/llvm/docs/FAQ.rst +++ b/llvm/docs/FAQ.rst @@ -13,7 +13,7 @@ Can I modify LLVM source code and redistribute the modified source? ------------------------------------------------------------------- Yes. The modified source distribution must retain the copyright notice and follow the conditions listed in the `Apache License v2.0 with LLVM Exceptions -`_. +`_. Can I modify the LLVM source code and redistribute binaries or other tools based on it, without redistributing the source? diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index d4e4a3b03928..a2274f80fc1f 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/docs/GettingStarted.rst @@ -457,7 +457,7 @@ either via emailing to llvm-commits, or, preferably, via :ref:`Phabricator You'll generally want to make sure your branch has a single commit, corresponding to the review you wish to send, up-to-date with the upstream -``origin/master`` branch, and doesn't contain merges. Once you have that, you +``origin/main`` branch, and doesn't contain merges. Once you have that, you can start `a Phabricator review `_ (or use ``git show`` or ``git format-patch`` to output the diff, and attach it to an email message). @@ -501,7 +501,7 @@ For developers to commit changes from Git ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once a patch is reviewed, you should rebase it, re-test locally, and commit the -changes to LLVM's master branch. This is done using `git push` if you have the +changes to LLVM's main branch. This is done using `git push` if you have the required access rights. See `committing a change `_ for Phabricator based commits or `obtaining commit access `_ @@ -515,13 +515,13 @@ accepted commit on the branch named `branch-with-change`. # Go to the branch with your accepted commit. % git checkout branch-with-change # Rebase your change onto the latest commits on Github. - % git pull --rebase origin master + % git pull --rebase origin main # Rerun the appropriate tests if needed. % ninja check-$whatever # Check that the list of commits about to be pushed is correct. - % git log origin/master...HEAD --oneline + % git log origin/main...HEAD --oneline # Push to Github. - % git push origin HEAD:master + % git push origin HEAD:main LLVM currently has a linear-history policy, which means that merge commits are not allowed. The `llvm-project` repo on github is configured to reject pushes diff --git a/llvm/docs/GitBisecting.rst b/llvm/docs/GitBisecting.rst index 8f44e351a085..81876c74caa7 100644 --- a/llvm/docs/GitBisecting.rst +++ b/llvm/docs/GitBisecting.rst @@ -23,7 +23,7 @@ See https://git-scm.com/docs/git-bisect for a good overview. In summary: .. code-block:: bash git bisect start - git bisect bad master + git bisect bad main git bisect good f00ba git will check out a revision in between. Try to reproduce your problem at @@ -33,8 +33,8 @@ If you can't repro at the current commit (maybe the build is broken), run ``git bisect skip`` and git will pick a nearby alternate commit. (To abort a bisect, run ``git bisect reset``, and if git complains about not -being able to reset, do the usual ``git checkout -f master; git reset --hard -origin/master`` dance and try again). +being able to reset, do the usual ``git checkout -f main; git reset --hard +origin/main`` dance and try again). ``git bisect run`` ================== diff --git a/llvm/docs/GlobalISel/IRTranslator.rst b/llvm/docs/GlobalISel/IRTranslator.rst index 712fe95a8292..9e12fdcbcbe5 100644 --- a/llvm/docs/GlobalISel/IRTranslator.rst +++ b/llvm/docs/GlobalISel/IRTranslator.rst @@ -91,5 +91,5 @@ This is beneficial as it allows us to fold constants into immediate operands during :ref:`instructionselect`, while still avoiding redundant materializations for expensive non-foldable constants. However, this can lead to unnecessary spills and reloads in an -O0 pipeline, as these virtual registers can have long -live ranges. This can be mitigated by running a `localizer `_ +live ranges. This can be mitigated by running a `localizer `_ after the translator. diff --git a/llvm/docs/LibFuzzer.rst b/llvm/docs/LibFuzzer.rst index 70a3f029c6f3..b251895bc8e9 100644 --- a/llvm/docs/LibFuzzer.rst +++ b/llvm/docs/LibFuzzer.rst @@ -571,7 +571,7 @@ Periodically restart both fuzzers so that they can use each other's findings. Currently, there is no simple way to run both fuzzing engines in parallel while sharing the same corpus dir. You may also use AFL on your target function ``LLVMFuzzerTestOneInput``: -see an example `here `__. +see an example `here `__. How good is my fuzzer? ---------------------- @@ -815,7 +815,7 @@ Trophies .. _AddressSanitizer: https://clang.llvm.org/docs/AddressSanitizer.html .. _LeakSanitizer: https://clang.llvm.org/docs/LeakSanitizer.html .. _Heartbleed: http://en.wikipedia.org/wiki/Heartbleed -.. _FuzzerInterface.h: https://github.com/llvm/llvm-project/blob/master/compiler-rt/lib/fuzzer/FuzzerInterface.h +.. _FuzzerInterface.h: https://github.com/llvm/llvm-project/blob/main/compiler-rt/lib/fuzzer/FuzzerInterface.h .. _3.7.0: https://llvm.org/releases/3.7.0/docs/LibFuzzer.html .. _building Clang from trunk: https://clang.llvm.org/get_started.html .. _MemorySanitizer: https://clang.llvm.org/docs/MemorySanitizer.html diff --git a/llvm/docs/TestingGuide.rst b/llvm/docs/TestingGuide.rst index 0f9129205756..2070e3842761 100644 --- a/llvm/docs/TestingGuide.rst +++ b/llvm/docs/TestingGuide.rst @@ -73,7 +73,7 @@ transforming it. They are tested in general using the same infrastructure as the regression tests, by creating a separate "Printer" pass to consume the analysis result and print it on the standard output in a textual format suitable for FileCheck. -See `llvm/test/Analysis/BranchProbabilityInfo/loop.ll `_ +See `llvm/test/Analysis/BranchProbabilityInfo/loop.ll `_ for an example of such test. ``test-suite`` diff --git a/llvm/docs/TypeMetadata.rst b/llvm/docs/TypeMetadata.rst index 74d439411497..5fa864dc8ab2 100644 --- a/llvm/docs/TypeMetadata.rst +++ b/llvm/docs/TypeMetadata.rst @@ -223,7 +223,7 @@ efficiently to minimize the sizes of the underlying bitsets. ret void } -.. _GlobalLayoutBuilder: https://github.com/llvm/llvm-project/blob/master/llvm/include/llvm/Transforms/IPO/LowerTypeTests.h +.. _GlobalLayoutBuilder: https://github.com/llvm/llvm-project/blob/main/llvm/include/llvm/Transforms/IPO/LowerTypeTests.h ``!vcall_visibility`` Metadata ==============================