This is an archive of the discontinued LLVM Phabricator instance.

Add discussion of git-format-patch to Phabricator.html
ClosedPublic

Authored by kbarton on Oct 22 2019, 2:36 PM.

Details

Summary

There is a discussion of git-format-patch in GettingStarted guide, but no mention of it in the Phabricator.html page.

Event Timeline

kbarton created this revision.Oct 22 2019, 2:36 PM
Herald added a project: Restricted Project. · View Herald TranscriptOct 22 2019, 2:36 PM
delcypher requested changes to this revision.Oct 25 2019, 10:29 AM

Thanks for the patch. I didn't know that this information was missing from our docs!

llvm/docs/Phabricator.rst
65

I think this needs to be put into its own section because it's not specific to "Requesting a review via the web interface". Formatting is really about preparing for a review rather than requesting it.

Perhaps this information belongs in "How to Submit a Patch" section of the contributing guide and then we could reference that section from this document?

Thoughts?

This revision now requires changes to proceed.Oct 25 2019, 10:29 AM
kbarton updated this revision to Diff 231559.Nov 29 2019, 9:07 AM
kbarton edited the summary of this revision. (Show Details)
  • Move description of clang-format to Contributing.rst and add a link to Phabricator.rst to reference it.

Thanks for the review @delcypher!

I agree it's probably better to move this. I've put it under the "How to Submit a Patch" section in Contributing.rst, and added a link to it in Phabricator.rst as you suggested.

The only thing I'm not sure about is whether to create a new subsection for it, or just leave it as inline text and link to the paragraph directly (which is what I did). The problem I had with a new subsection was getting "out" of the new subsection for the rest of the instructions under "How to Submit a Patch" (hopefully that makes sense).

The only thing I'm not sure about is whether to create a new subsection for it, or just leave it as inline text and link to the paragraph directly (which is what I did).

I think as the patch is now is fine.

The problem I had with a new subsection was getting "out" of the new subsection for the rest of the instructions under "How to Submit a Patch" (hopefully that makes sense).

I'm not sure what you mean here.

delcypher accepted this revision.Nov 29 2019, 10:14 AM
This revision is now accepted and ready to land.Nov 29 2019, 10:14 AM

The problem I had with a new subsection was getting "out" of the new subsection for the rest of the instructions under "How to Submit a Patch" (hopefully that makes sense).

I'm not sure what you mean here.

I wouldn't worry about it - this is more my random meanderings.... If you're OK with this, I'll commit it as is.

Thanks again for the review!

This revision was automatically updated to reflect the committed changes.