Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2025-02-13 13:45:16 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: Update instructions for requesting backports to the release branches

Browse Source 
Reviewed By: lattner

Differential Revision: https://reviews.llvm.org/D120974
This commit is contained in:
Tom Stellard 2022-03-08 15:49:32 -08:00
parent 8de6260a20
commit 9cb0605c0e
3 changed files with 48 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
llvm/docs/GettingInvolved.rst
View File

@ -18,6 +18,7 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
HowToSubmitABug
BugLifeCycle
CodingStandards
GitHub
GitBisecting
GitRepositoryPolicy
@ -52,6 +53,9 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
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.

41
llvm/docs/GitHub.rst Normal file
View File

@ -0,0 +1,41 @@
======================
LLVM GitHub User Guide
======================
Introduction
============
The LLVM Project uses `GitHub <https://github.com/>`_ for
`Source Code <https://github.com/llvm/llvm-project>`_,
`Releases <https://github.com/llvm/llvm-project/releases>`_, and
`Issue Tracking <https://github.com/llvm/llvm-project/issues>`_.
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 <commit> <commit> <...>
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 <owner>/<repo>/<branch>
This command will create a pull request against the latest release branch using
the <branch> from the <owner>/<repo> repository. <branch> cannot contain any
forward slash '/' characters.

23
llvm/docs/HowToReleaseLLVM.rst
View File

@ -257,27 +257,10 @@ If a bug can't be reproduced, or stops being a blocker, it should be removed
from the Meta and its priority decreased to *normal*. Debugging can continue,
but on trunk.
Merge Requests
--------------
Backport 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.
.. _bug: https://bugs.llvm.org/
Instructions for requesting a backport to a stable branch can be found :doc:`here <GitHub>`.
Release Patch Rules
-------------------