[PATCH] D78867: [docs] avoid 'arc land' command

[Sergei Trofimovich via Phabricator via llvm-commits]

trofi updated this revision to Diff 260704.
trofi added a comment.

Instead of tweaking `arc land` command add a note to strip all
Phabricator tags except `Differential Revision`.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D78867/new/

https://reviews.llvm.org/D78867

Files:
  llvm/docs/Phabricator.rst


Index: llvm/docs/Phabricator.rst
===================================================================
--- llvm/docs/Phabricator.rst
+++ llvm/docs/Phabricator.rst
@@ -200,14 +200,27 @@
 commit message derived from information in the Phabricator review.
 
 Check you are happy with the commit message and amend it if necessary.
-For example, ensure the 'Author' property of the commit is set to the original author.
+For example, ensure that:
+
+* the ``Author`` property of the commit is set to the original author.
+* all phabricator tags except ``Differential Revision`` are stripped
+  from commit message.
+
 You can use a command to correct the author property if it is incorrect:
 
 ::
 
   git commit --amend --author="John Doe <jdoe at llvm.org>"
 
-Then, make sure the commit is up-to-date, and commit it. This can be done by running
+
+Otherwise you can clean commit message as:
+
+::
+
+  git commit --amend
+
+
+Then, make sure the commit is up-to-date, and push it. This can be done by running
 the following:
 
 ::
@@ -217,12 +230,10 @@
   ninja check-$whatever # Rerun the appropriate tests if needed.
   git push
 
-Or
-
-::
-
-  arc land D<Revision>
 
+Avoid using `arc land` as it keeps redundant tags in the commit message.
+Redundant tag examples are ``Summary``, ``Reviewers``, ``Subscribers``,
+``Tags``.
 
 Abandoning a change
 -------------------


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D78867.260704.patch
Type: text/x-patch
Size: 1366 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200428/505da8d0/attachment.bin>