sapling/doc
Patrick Mezard 92074cd441 patch: deprecate ui.patch / external patcher feature
Why?
- Mercurial internal patcher works correctly for regular patches and git
  patches, is much faster at least on Windows and is more extensible.
- In theory, the external patcher can be used to handle exotic patch formats. I
  do not know any and have not heard about any such use in years.
- Most patch programs cannot handle git format patches, which makes the API
  caller to decide either to ignore ui.patch by calling patch.internalpatch()
  directly, or take the risk of random failures with valid inputs.
- One thing a patch program could do Mercurial patcher cannot is applying with
  --reverse. Apparently several shelve like extensions try to use that,
  including passing the "reverse" option to Mercurial patcher, which has been
  removed mid-2009. I never heard anybody complain about that, and would prefer
  reimplementing it anyway.

And from the technical perspective:
- The external patcher makes everything harder to maintain and implement. EOL
  normalization is not implemented, and I would bet file renames, if supported
  by the patcher, are not correctly recorded in the dirstate.
- No tests.

How?
- Remove related documentation
- Clearly mark patch.externalpatch() as private
- Remove the debuginstall check. This deprecation request was actually
  triggered by this last point. debuginstall is the only piece of code patching
  without a repository. When migrating to an integrated patch() + updatedir()
  call, this was really a showstopper, all workarounds were either ugly or
  uselessly complicated to implement. If we do not support external patcher
  anymore, the debuginstall check is not useful anymore.
- Remove patch.externalpatch() after 1.9 release.
2011-03-24 10:28:29 +01:00
..
common.txt doc: link man pages to one another 2009-07-16 23:25:26 +02:00
gendoc.py doc: Capitalize the "options" header of mercurial commands 2011-02-05 14:37:25 +00:00
hg.1.txt gendoc: move section commands to module scope 2010-10-20 18:07:50 +02:00
hgignore.5.txt Update license to GPLv2+ 2010-01-19 22:20:08 -06:00
hgmanpage.py *: kill all unnecessary shebangs. 2010-10-26 12:18:39 +02:00
hgrc.5.txt patch: deprecate ui.patch / external patcher feature 2011-03-24 10:28:29 +01:00
Makefile runrst: add RSTARGS Makefile variable to allow customization 2010-12-01 09:46:11 +09:00
README doc/README: simplify instructions 2009-09-03 21:40:45 +02:00
runrst runrst: try to be more helpful if docutils is not installed 2010-07-30 14:41:47 +09:00
style.css gendoc: added styling for extension TOC 2010-10-20 17:47:46 +02:00

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML. You'll need to install Docutils:

  http://docutils.sourceforge.net/

Use the Makefile in this directory to generate the man and HTML pages.