README.rst
author Pierre-Yves David <pierre-yves.david@octobus.net>
Tue, 24 May 2022 09:36:40 +0200
branchstable
changeset 48873 c95e5ba4de1e
parent 46769 c5912e35d06d
permissions -rw-r--r--
run-tests: also send a message in the Keyboard interrupt case The next patch will do something equivalent, so lets do the change in an independant changeset first in case we need to bisect something in the future.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12857
a9f91c844a3b README: add small introduction
Martin Geisler <mg@lazybytes.net>
parents: 12856
diff changeset
     1
Mercurial
a9f91c844a3b README: add small introduction
Martin Geisler <mg@lazybytes.net>
parents: 12856
diff changeset
     2
=========
a9f91c844a3b README: add small introduction
Martin Geisler <mg@lazybytes.net>
parents: 12856
diff changeset
     3
a9f91c844a3b README: add small introduction
Martin Geisler <mg@lazybytes.net>
parents: 12856
diff changeset
     4
Mercurial is a fast, easy to use, distributed revision control tool
a9f91c844a3b README: add small introduction
Martin Geisler <mg@lazybytes.net>
parents: 12856
diff changeset
     5
for software developers.
a9f91c844a3b README: add small introduction
Martin Geisler <mg@lazybytes.net>
parents: 12856
diff changeset
     6
33617
76b171209151 README: make paragraphs before example code end with "::" for reST syntax
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 26421
diff changeset
     7
Basic install::
0
9117c6561b0b Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff changeset
     8
3935
1158d7018052 Move README info to wiki
Matt Mackall <mpm@selenic.com>
parents: 3847
diff changeset
     9
 $ make            # see install targets
1158d7018052 Move README info to wiki
Matt Mackall <mpm@selenic.com>
parents: 3847
diff changeset
    10
 $ make install    # do a system-wide install
1158d7018052 Move README info to wiki
Matt Mackall <mpm@selenic.com>
parents: 3847
diff changeset
    11
 $ hg debuginstall # sanity-check setup
1158d7018052 Move README info to wiki
Matt Mackall <mpm@selenic.com>
parents: 3847
diff changeset
    12
 $ hg              # see help
205
d255d99a7cbd README: integrate some changes from Kevin Smith
mpm@selenic.com
parents: 204
diff changeset
    13
33617
76b171209151 README: make paragraphs before example code end with "::" for reST syntax
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 26421
diff changeset
    14
Running without installing::
16217
df5ecb813426 readme: mention how to run in-place
Ross Lagerwall <rosslagerwall@gmail.com>
parents: 12857
diff changeset
    15
df5ecb813426 readme: mention how to run in-place
Ross Lagerwall <rosslagerwall@gmail.com>
parents: 12857
diff changeset
    16
 $ make local      # build for inplace usage
df5ecb813426 readme: mention how to run in-place
Ross Lagerwall <rosslagerwall@gmail.com>
parents: 12857
diff changeset
    17
 $ ./hg --version  # should show the latest version
df5ecb813426 readme: mention how to run in-place
Ross Lagerwall <rosslagerwall@gmail.com>
parents: 12857
diff changeset
    18
26421
4b0fc75f9403 urls: bulk-change primary website URLs
Matt Mackall <mpm@selenic.com>
parents: 16217
diff changeset
    19
See https://mercurial-scm.org/ for detailed installation
3935
1158d7018052 Move README info to wiki
Matt Mackall <mpm@selenic.com>
parents: 3847
diff changeset
    20
instructions, platform-specific notes, and Mercurial user information.
46769
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    21
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    22
Notes for packagers
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    23
===================
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    24
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    25
Mercurial ships a copy of the python-zstandard sources. This is used to
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    26
provide support for zstd compression and decompression functionality. The
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    27
module is not intended to be replaced by the plain python-zstandard nor
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    28
is it intended to use a system zstd library. Patches can result in hard
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    29
to diagnose errors and are explicitly discouraged as unsupported
c5912e35d06d README: document requirement for builtin zstd
Joerg Sonnenberger <joerg@bec.de>
parents: 34579
diff changeset
    30
configuration.