contrib/plan9/README
author Gregory Szorc <gregory.szorc@gmail.com>
Sat, 17 Oct 2015 11:14:52 -0700
changeset 26755 bb0b955d050d
parent 26421 4b0fc75f9403
permissions -rw-r--r--
streamclone: support for producing and consuming stream clone bundles Up to this point, stream clones only existed as a dynamically generated data format produced and consumed during streaming clones. In order to support this efficient cloning format with the clone bundles feature, we need a more formal, on disk representation of the streaming clone data. This patch introduces a new "bundle" type for streaming clones. Unlike existing bundles, it does not contain changegroup data. It does, however, share the same concepts like the 4 byte header which identifies the type of data that follows and the 2 byte abbreviation for compression types (of which only "UN" is currently supported). The new bundle format is essentially the existing stream clone version 1 data format with some headers at the beginning. Content negotiation at stream clone request time checked for repository format/requirements compatibility before initiating a stream clone. We can't do active content negotiation when using clone bundles. So, we put this set of requirements inside the payload so consumers have a built-in mechanism for checking compatibility before reading and applying lots of data. Of course, we will also advertise this requirements set in clone bundles. But that's for another patch. We currently don't have a mechanism to produce and consume this new bundle format. This will be implemented in upcoming patches. It's worth noting that if a legacy client attempts to `hg unbundle` a stream clone bundle (with the "HGS1" header), it will abort with: "unknown bundle version S1," which seems appropriate.

Mercurial for Plan 9 from Bell Labs
===================================

This directory contains support for Mercurial on Plan 9 from Bell Labs
platforms. It is assumed that the version of Python running on these
systems supports the ANSI/POSIX Environment (APE). At the time of this
writing, the bichued/python port is the most commonly installed version
of Python on these platforms. If a native port of Python is ever made,
some minor modification will need to be made to support some of the more
esoteric requirements of the platform rather than those currently made
(cf. posix.py).

By default, installations will have the factotum extension enabled; this
extension permits factotum(4) to act as an authentication agent for
HTTP repositories. Additionally, an extdiff command named 9diff is
enabled which generates diff(1) compatible output suitable for use with
the plumber(4).

Commit messages are plumbed using E if no editor is defined; users must
update the plumbed file to continue, otherwise the hg process must be
interrupted.

Some work remains with regard to documentation. Section 5 manual page
references for hgignore and hgrc need to be re-numbered to section 6 (file
formats) and a new man page writer should be written to support the
Plan 9 man macro set. Until these issues can be resolved, manual pages
are elided from the installation.

Basic install:

  % mk install      # do a system-wide install
  % hg debuginstall # sanity-check setup
  % hg              # see help

A proto(2) file is included in this directory as an example of how a
binary distribution could be packaged, ostensibly with contrib(1).

See https://mercurial-scm.org/ for detailed installation
instructions, platform-specific notes, and Mercurial user information.