[llvm] 04f6bf4 - Revise outdated parts of the developer policy.
Edd Barrett via llvm-commits
llvm-commits at lists.llvm.org
Mon Jul 4 02:11:39 PDT 2022
Author: Edd Barrett
Date: 2022-07-04T07:05:29+01:00
New Revision: 04f6bf482b8641533274d28af5fdac7107da3344
URL: https://github.com/llvm/llvm-project/commit/04f6bf482b8641533274d28af5fdac7107da3344
DIFF: https://github.com/llvm/llvm-project/commit/04f6bf482b8641533274d28af5fdac7107da3344.diff
LOG: Revise outdated parts of the developer policy.
Specifically:
- Diffs are not passed around on mailing lists any more.
- Diffs should be `-U999999`.
- Clarify part about automated emails.
Differential review: https://reviews.llvm.org/D128645
Added:
Modified:
llvm/docs/DeveloperPolicy.rst
Removed:
################################################################################
diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index c88d27b9d2fa..820e611ef172 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -84,30 +84,12 @@ to read it as possible. As such, we recommend that you:
patches may not apply correctly if the underlying code changes between the
time the patch was created and the time it is applied.
-#. Patches should be made with ``git format-patch``, or similar (see special
- commands for `Requesting Phabricator review via the web interface
- <Phabricator.html#phabricator-request-review-web>`_ ). If you use a
-
diff erent tool, make sure it uses the ``
diff -u`` format and that it
- doesn't contain clutter which makes it hard to read.
-
-Once your patch is ready, submit it by emailing it to the appropriate project's
-commit mailing list (or commit it directly if applicable). Alternatively, some
-patches get sent to the project's development list or component of the LLVM bug
-tracker, but the commit list is the primary place for reviews and should
-generally be preferred.
-
-When sending a patch to a mailing list, it is a good idea to send it as an
-*attachment* to the message, not embedded into the text of the message. This
-ensures that your mailer will not mangle the patch when it sends it (e.g. by
-making whitespace changes or by wrapping lines).
-
-*For Thunderbird users:* Before submitting a patch, please open *Preferences >
-Advanced > General > Config Editor*, find the key
-``mail.content_disposition_type``, and set its value to ``1``. Without this
-setting, Thunderbird sends your attachment using ``Content-Disposition: inline``
-rather than ``Content-Disposition: attachment``. Apple Mail gamely displays such
-a file inline, making it
diff icult to work with for reviewers using that
-program.
+#. Patches should be unified
diff s with "infinite context" (i.e. using something
+ like `git
diff -U999999 main`).
+
+#. Once you have created your patch, create a
+ `Phabricator review <Phabricator.html#phabricator-request-review-web>`_ for
+ it (or commit it directly if applicable).
When submitting patches, please do not add confidentiality or non-disclosure
notices to the patches themselves. These notices conflict with the LLVM
@@ -416,9 +398,11 @@ someone with commit access commits on your behalf. When doing so, please
provide the name and email address you would like to use in the Author
property of the commit.
-Your first commit to a repository may require the autogenerated email to be
-approved by a moderator of the mailing list.
-This is normal and will be done when the mailing list owner has time.
+For external tracking purposes, committed changes are automatically reflected
+on a commits mailing list soon after the commit lands (e.g. llvm-commits_).
+Note that these mailing lists are moderated, and it is not unusual for a large
+commit to require a moderator to approve the email, so do not be concerned if a
+commit does not immediately appear in the archives.
If you have recently been granted commit access, these policies apply:
More information about the llvm-commits
mailing list