Skip to content

Commit 2bdeb0d

Browse files
committed
More docs from the review
1 parent d0685cf commit 2bdeb0d

File tree

2 files changed

+24
-15
lines changed

2 files changed

+24
-15
lines changed

llvm/docs/DeveloperPolicy.rst

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,19 @@ one of the `pr-subscribers-* <https://github.com/orgs/llvm/teams?query=pr-subscr
5757
GitHub teams. This `mapping <https://github.com/llvm/llvm-project/blob/main/.github/new-prs-labeler.yml>`_
5858
documents the paths that trigger notifications for each of the listed teams.
5959

60-
Missing features and bugs are tracked through our `GitHub issue tracker <https://github.com/llvm/llvm-project/issues>`_
61-
and assigned labels. You can subscribe for notification for specific components
62-
by joining
63-
one of the `issue-subscribers-*
60+
Missing features and bugs are tracked through our `GitHub issue tracker
61+
<https://github.com/llvm/llvm-project/issues>`_. You can subscribe for
62+
notification for specific components by joining one of the `issue-subscribers-*
6463
<https://github.com/orgs/llvm/teams?query=issue-subscribers>`_ teams. You may
6564
also subscribe to the `llvm-bugs
6665
<http://lists.llvm.org/mailman/listinfo/llvm-bugs>`_ email list to subscribe to
6766
the firehose of all issue notifications, which some community members use to
6867
perform custom filtering.
6968

70-
Beyond the main formal communication channels, LLVM has a Discord server for
71-
real-time chat communication, as well as a community calendar with many regular
72-
workgroup video calls and office hours. See :doc:`GettingInvolved` for more
73-
information on other ways to engage with the community.
69+
Beyond the asynchronous written communication channels, LLVM has a Discord
70+
server for real-time chat communication, as well as a community calendar with
71+
many regular workgroup video calls and office hours. See :doc:`GettingInvolved`
72+
for more information on other ways to engage with the community.
7473

7574
.. _patch:
7675

@@ -93,8 +92,10 @@ Here are some tips to enable a successful code review:
9392
code you want to modify, and add ``@username`` to a PR comment to notify them
9493
of your PR if you are unable to add reviewers yourself due to GitHub permissions.
9594

96-
* To avoid precommit CI failures due to merge conflicts, base your patches on a recent commit from ``main``. If you want to make changes to a release branch, land
97-
a change in ``main`` first and ask a release manager to backport it.
95+
* To avoid precommit CI failures due to merge conflicts, base your patches on a
96+
recent commit from ``main``. If you want to make changes to a release branch,
97+
land a change in ``main`` first and then follow the
98+
:ref:`backporting instructions <backporting>`.
9899

99100
See :doc:`CodeReview` for more info on what to expect.
100101

@@ -173,7 +174,7 @@ maintainer. However, we are looking for people who can commit to:
173174

174175
* engaging in their responsibilities the majority of the days in a month,
175176
* ensuring that they, and the community members they interact with, abide by the
176-
LLVM Community Code of Conduct, and
177+
:ref:`LLVM Community Code of Conduct`, and
177178
* performing these duties for at least three months.
178179

179180
We recognize that priorities shift, job changes happen, burnout is real,
@@ -231,6 +232,12 @@ features added. Some tips for getting your testcase approved:
231232
`mlir/utils/generate-test-checks.py <https://github.com/llvm/llvm-project/blob/main/mlir/utils/generate-test-checks.py>`_
232233
and `llvm/utils/update_llc_test_checks.py <https://github.com/llvm/llvm-project/blob/main/llvm/utils/update_llc_test_checks.py>`_
233234

235+
* Some subprojects such as ``clang`` and ``clangd`` have project specific
236+
testing tools, like the ``clang -verify`` flag (`docs
237+
<https://clang.llvm.org/docs/InternalsManual.html#verifying-diagnostics>`_)
238+
and the ``clangd -lit-test``
239+
flag, which are preferred over FileCheck.
240+
234241
* Changes to libraries, such as Support, which are not directly observable
235242
through tool invocations, are often best tested with unit tests. Unit tests
236243
are located under the ``unittests`` subdirectory of each subproject.
@@ -245,10 +252,10 @@ features added. Some tips for getting your testcase approved:
245252
documentation, etc. Instead, add sufficient comments to the test to provide
246253
the context behind such links.
247254

248-
Note that ``llvm/test`` and ``clang/test`` are designed for regression and
249-
small feature tests only. More extensive test cases (e.g., entire applications,
250-
benchmarks, etc) should be added to the
251-
`llvm-test-suite <https://github.com/llvm/llvm-test-suite>`_ repository. The
255+
As a project, we prefer to separate tests into small in-tree tests, and large
256+
out-of-tree integration tests. More extensive integration test cases (e.g.,
257+
entire applications, benchmarks, etc) should be added to the `llvm-test-suite
258+
<https://github.com/llvm/llvm-test-suite>`_ repository. The
252259
``llvm-test-suite`` repository is for integration and application testing
253260
(correctness, performance, etc) testing, not feature or regression testing. It
254261
also serves to separate out third party code that falls under a different

llvm/docs/GitHub.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,8 @@ See more in-depth information about how to contribute in the following documenta
537537
Releases
538538
========
539539

540+
.. _backporting:
541+
540542
Backporting Fixes to the Release Branches
541543
-----------------------------------------
542544
You can use special comments on issues or pull requests to make backport

0 commit comments

Comments
 (0)