[PATCH] D115519: [llvm][docs] Describe how to work with patch series on Phabricator

[James Henderson via Phabricator via llvm-commits]

jhenderson added inline comments.


================
Comment at: llvm/docs/Phabricator.rst:138
+`This page <https://moz-conduit.readthedocs.io/en/latest/arcanist-user.html#series-of-commits>`_
+describes two ways to do this. One for submissions via arc and one
+for the web interface.
----------------
I'm not all that convinced about referring to the external arcanist reference here, since arcanist is only one way of uploading patches for review. I would be more inclined to just summarise the contents, e.g. the following two paragraphs:

"Creating a patch series requires some manual work. There are two methods to achieve this. The first approach is to create a patch using arc or the web interface for each individual commit, and then select the "Edit Related Revisions->Edit Parent Revisions" option in the Phabricator UI for each patch after the first in the series. This will open a dialog where you can enter the patch number (e.g. `D12345`) of the parent patch(es). Click "Save Parent Revisions" after entering them.

The second approach is to create the patches and simply add "Depends on DXXXXXX" to the patch description (where "DXXXXXX" is replaced by the parent's patch number) in the child patch, entirely on its own line, with a blank line before it."

You could still add a link, if you felt the concrete examples are helpful.


================
Comment at: llvm/docs/Phabricator.rst:141-144
+A recommended workflow is to interactively rebase back to the first commit
+for review. Marking that and all your subsequent commits to be
+edited. At each commit make the necessary changes, submit with arc or the web
+interface and then continue the rebase.
----------------
I'm not entirely convinced this paragraph is a) that useful, and b) all that understandable. A recommended workflow for what? Assuming "creating a commit series", in which case, what does "make the necessary changes" mean in this case?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D115519