[docs] use git diff instead of git format-patch
authorAlexander Lanin <alex@lanin.de>
Thu, 2 Apr 2020 14:18:34 +0000 (07:18 -0700)
committerPaul Robinson <paul.robinson@sony.com>
Thu, 2 Apr 2020 14:20:27 +0000 (07:20 -0700)
Uploading output from `git format-patch` fails when version has
more than 2 dots, e.g. git version 2.24.1.windows.2 which is
currently recommended by e.g. GitExtensions or 2.24.1.rc on Linux.

Differential Revision: https://reviews.llvm.org/D72374

llvm/docs/DeveloperPolicy.rst
llvm/docs/GettingStarted.rst
llvm/docs/Phabricator.rst

index 0b3051a..22f29a0 100644 (file)
@@ -89,7 +89,9 @@ 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. If you use a
+#. 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
    different tool, make sure it uses the ``diff -u`` format and that it
    doesn't contain clutter which makes it hard to read.
 
index 60b0bbf..b21c125 100644 (file)
@@ -447,8 +447,8 @@ either via emailing to llvm-commits, or, preferably, via :ref:`Phabricator
 You'll generally want to make sure your branch has a single commit,
 corresponding to the review you wish to send, up-to-date with the upstream
 ``origin/master`` branch, and doesn't contain merges. Once you have that, you
-can use ``git show`` or ``git format-patch`` to output the diff, and attach it
-to a Phabricator review (or to an email message).
+can start `a Phabricator review <Phabricator.html>`_ (or use ``git show`` or
+``git format-patch`` to output the diff, and attach it to an email message).
 
 However, using the "Arcanist" tool is often easier. After `installing
 arcanist`_, you can upload the latest commit using:
index bd843d4..f6b7fa5 100644 (file)
@@ -59,7 +59,8 @@ To get a full diff, use one of the following commands (or just use Arcanist
 to upload your patch):
 
 * ``git show HEAD -U999999 > mypatch.patch``
-* ``git format-patch -U999999 @{u}``
+* ``git diff -U999999 @{u} > mypatch.patch``
+* ``git diff HEAD~1 -U999999 > mypatch.patch``
 
 Before uploading your patch, please make sure it is formatted properly, as
 described in :ref:`How to Submit a Patch <format patches>`.