diff --git a/llvm/docs/GettingInvolved.rst b/llvm/docs/GettingInvolved.rst --- a/llvm/docs/GettingInvolved.rst +++ b/llvm/docs/GettingInvolved.rst @@ -18,6 +18,7 @@ HowToSubmitABug BugLifeCycle CodingStandards + GitHub GitBisecting GitRepositoryPolicy @@ -52,6 +53,9 @@ Details the LLVM coding standards and provides useful information on writing efficient C++ code. +:doc:`GitHub` + Describes how to use the llvm-project repository on GitHub. + :doc:`GitBisecting` Describes how to use ``git bisect`` on LLVM's repository. diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst new file mode 100644 --- /dev/null +++ b/llvm/docs/GitHub.rst @@ -0,0 +1,41 @@ +====================== +LLVM GitHub User Guide +====================== + +Introduction +============ +The LLVM Project uses `GitHub `_ for +`Source Code `_, +`Releases `_, and +`Issue Tracking `_. + +This page describes how the LLVM Project users and developers can +participate in the project using GitHub. + +Releases +======== + +Backporting Fixes to the Release Branches +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +You can use special comments on issues to make backport requests for the +release branches. This is done by making a comment containing one of the +following commands on any issue that has been added to one of the "X.Y.Z Release" +milestones. + +:: + + /cherry-pick <...> + +This command takes one or more git commit hashes as arguments and will attempt +to cherry-pick the commit(s) to the release branch. If the commit(s) fail to +apply cleanly, then a comment with a link to the failing job will be added to +the issue. If the commit(s) do apply cleanly, then a pull request will +be created with the specified commits. + +:: + + /branch // + +This command will create a pull request against the latest release branch using +the from the / repository. cannot contain any +forward slash '/' characters. diff --git a/llvm/docs/HowToReleaseLLVM.rst b/llvm/docs/HowToReleaseLLVM.rst --- a/llvm/docs/HowToReleaseLLVM.rst +++ b/llvm/docs/HowToReleaseLLVM.rst @@ -257,27 +257,10 @@ from the Meta and its priority decreased to *normal*. Debugging can continue, but on trunk. -Merge Requests --------------- - -You can use any of the following methods to request that a revision from trunk -be merged into a release branch: - -#. Use the ``utils/release/merge-request.sh`` script which will automatically - file a bug_ requesting that the patch be merged. e.g. To request revision - 12345 be merged into the branch for the 5.0.1 release: - ``llvm.src/utils/release/merge-request.sh -stable-version 5.0 -r 12345 -user bugzilla@example.com`` - -#. Manually file a bug_ with the subject: "Merge r12345 into the X.Y branch", - enter the commit(s) that you want merged in the "Fixed by Commit(s)" and mark - it as a blocker of the current release bug. Release bugs are given aliases - in the form of release-x.y.z, so to mark a bug as a blocker for the 5.0.1 - release, just enter release-5.0.1 in the "Blocks" field. - -#. Reply to the commit email on llvm-commits for the revision to merge and cc - the release manager. +Backport Requests +----------------- -.. _bug: https://bugs.llvm.org/ +Instructions for requesting a backport to a stable branch can be found :doc:`here `. Release Patch Rules -------------------