Page MenuHomePhabricator

git-phab documentation needs improving
Open, NormalPublic

Description

Currently the documentation is at https://phab.enlightenment.org/w/arcanist/ but this was only supposed to be a temporary page until someone improved it.

Documentation should include:

  • difference between git-phab and plain arcanist
  • git-phab installation and setup instructions
  • some example usage of git-phab including
    • how to update an already-submitted patches
    • how to submit a range of patches (e.g., HEAD~2..HEAD)

It would also be great if someone knowledgeable in python could rework the hacks that I made to the upstream git-phab script so that we could submit the changes upstream to simplify the setup process.

zmike created this task.Jun 27 2018, 5:09 AM
zmike triaged this task as Showstopper Issues priority.
segfaultxavi claimed this task.EditedJun 28 2018, 8:00 AM
segfaultxavi added a subscriber: segfaultxavi.

Notes to self:

  • Rename page to Submission guide instead of Arcanist guide.
  • If you pull down a commit from phab, modify it, and then want to update the phab revision, you need to remove all the keywords added by phab in the commit log, e.g., Summary, Reviewers, ...

@zmike can you explain why your modified git-phab script is needed?

Also, do we want to put the words "complicated/hacky" on our site? :)

zmike added a comment.Jun 28 2018, 9:00 AM

The modified script is needed because the fdo one was written to work only on fdo and will always error and fail for any other system.

Ideally someone will improve the script without hacks and then upstream it. The upstream git-phab maintainer is looking for a new home for the project since fdo no longer uses phabricator, so we could potentially take it over entirely if someone with python took an interest in this.

segfaultxavi lowered the priority of this task from Showstopper Issues to Normal.Fri, Dec 7, 5:03 AM