diff options
author | Ethan Glasser-Camp <ethan@betacantrips.com> | 2018-10-16 15:09:55 -0400 |
---|---|---|
committer | Rok Garbas <rok@garbas.si> | 2018-10-17 10:58:03 +0200 |
commit | 65bfcb376612a2dc0439346e3af8dd0cd257a3de (patch) | |
tree | e8deb58a491e858c3b0d6b9ce7cf1bc4939051a5 | |
parent | dfb6fc568428679f7e4ef6d7279e6af5db240863 (diff) | |
download | nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.tar nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.tar.gz nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.tar.bz2 nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.tar.lz nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.tar.xz nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.tar.zst nixlib-65bfcb376612a2dc0439346e3af8dd0cd257a3de.zip |
Add another section about submitting Firefox patches
-rw-r--r-- | README.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.rst b/README.rst index c40f48da1605..d55958172029 100644 --- a/README.rst +++ b/README.rst @@ -174,6 +174,45 @@ environment variable, to reset the ``MOZCONFIG`` environment variable for you. ~/mozilla-central$ nix-shell ../nixpkgs-mozilla/release.nix -A gecko.x86_64-linux.gcc --pure [~/mozilla-central] python ./mach build +Submitting Firefox patches +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Firefox development happens in `Mozilla Phabricator +<https://phabricator.services.mozilla.com/>`_. Mozilla Phabricator +docs are `here +<https://moz-conduit.readthedocs.io/en/latest/phabricator-user.html>`_. + +To get your commits into Phabricator, some options include: + +- Arcanist, the upstream tool for interacting with + Phabricator. Arcanist is packaged in nixpkgs already; you can find + it in `nixos.arcanist`. Unfortunately, as of this writing, upstream + Arcanist does not support ``git-cinnabar`` (according to `the + "Setting up Arcanist" + <https://moz-conduit.readthedocs.io/en/latest/phabricator-user.html#setting-up-arcanist>`_ + documentation). `Mozilla maintains a fork of Arcanist + <https://github.com/mozilla-conduit/arcanist>`_ but it isn't yet + packaged. (PRs welcome.) + +- `moz-phab <https://github.com/mozilla-conduit/review>`_, a small + Python script that wraps Arcanist to try to handle commit series + better than stock Arcanist. Because it wraps Arcanist, it suffers + from the same problems that Arcanist does if you use git-cinnabar, + and may work better if you use Mozilla's Arcanist fork. ``moz-phab`` + isn't packaged yet. (PRs welcome.) + +- `phlay <https://github.com/mystor/phlay>`_, a small Python script + that speaks to the Phabricator API directly. This repository ships a + ``phlay-overlay.nix`` that you can use to make ``phlay`` available + in a nix-shell or nix-env. + +Note: although the ``nix-shell`` from the previous section may have +all the tools you would normally use to do Firefox development, it +isn't recommended that you use that shell for anything besides tasks +that involve running ``mach``. Other development tasks such as +committing code and submitting patches to code review are best handled +in a separate nix-shell. + TODO ---- |