Page MenuHomePhabricator

commands: rename clone --uncompressed to --stream and document

Authored by indygreg on Oct 1 2017, 6:31 AM.



--uncompressed isn't a very good name and its description in the
help documentation isn't very useful. We refer to this concept as
"stream clones" in a number of places. I think it makes sense to
change the user-facing argument to use the mode --stream. So this
commit does that.

We keep --uncompressed around for backwards compatibility.

While we're here, we overhaul the help docs for streaming clones
to be somewhat useful.

All tests have been updated to reflect the new preferred --stream
argument. A test for backwards compatibility of --uncompressed has
been added.

.. bc::

`hg clone --stream` should now be used instead of --uncompressed.

--uncompressed is marked as deprecated and is an alias for --stream.
There is no schedule for elimination of --uncompressed.

Diff Detail

rHG Mercurial
Automatic diff as part of commit; lint not applicable.
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Oct 1 2017, 6:31 AM
durin42 accepted this revision.Oct 1 2017, 6:49 AM
This revision is now accepted and ready to land.Oct 1 2017, 6:49 AM
simpkins accepted this revision.Oct 1 2017, 6:49 AM
simpkins added a subscriber: simpkins.

The code and test changes seem fine to me. I don't have context around the argument naming discussion, but it seems reasonable.

This revision was automatically updated to reflect the committed changes.