README_REPOSITORY
author wenzelm
Thu Nov 29 10:56:59 2012 +0100 (2012-11-29)
changeset 50281 cbba16084784
parent 49443 75633efcc70d
child 50453 262dc5873f80
permissions -rw-r--r--
further update and clarification of the all-important README_REPOSITORY;
wenzelm@28907
     1
Important notes on Mercurial repository access for Isabelle
wenzelm@28907
     2
===========================================================
wenzelm@28907
     3
wenzelm@49348
     4
Quick start in 20min
wenzelm@49348
     5
--------------------
wenzelm@49348
     6
wenzelm@49443
     7
1. Ensure that "hg" (Mercurial) is installed; see also
wenzelm@49443
     8
   http://www.selenic.com/mercurial
wenzelm@49348
     9
wenzelm@49348
    10
2. Create file $HOME/.isabelle/etc/settings and insert the following
wenzelm@49348
    11
   line near its beginning:
wenzelm@49348
    12
wenzelm@49348
    13
    init_components "$HOME/.isabelle/contrib" "$ISABELLE_HOME/Admin/components/main"
wenzelm@49348
    14
wenzelm@49348
    15
3. Execute shell commands as follows:
wenzelm@49348
    16
wenzelm@49348
    17
    hg clone http://isabelle.in.tum.de/repos/isabelle
wenzelm@49348
    18
wenzelm@49348
    19
    ./isabelle/bin/isabelle components -a
wenzelm@49348
    20
wenzelm@49348
    21
    ./isabelle/bin/isabelle build -b HOL
wenzelm@49348
    22
wenzelm@49348
    23
    ./isabelle/bin/isabelle jedit
wenzelm@49348
    24
wenzelm@50281
    25
4. For later update replace "hg clone ..." above by:
wenzelm@50281
    26
wenzelm@50281
    27
    cd isabelle
wenzelm@50281
    28
wenzelm@50281
    29
    hg pull -u
wenzelm@50281
    30
wenzelm@49348
    31
wenzelm@40601
    32
Introduction
wenzelm@40601
    33
------------
wenzelm@28907
    34
wenzelm@40601
    35
Mercurial http://www.selenic.com/mercurial belongs to the current
wenzelm@40601
    36
generation of source code management systems that follow the so-called
wenzelm@40601
    37
paradigm of "distributed version control".  This is a terrific name
wenzelm@40601
    38
for plain revision control without the legacy of CVS or SVN.  See also
wenzelm@40601
    39
http://hginit.com/ for an introduction to the main ideas.  The
wenzelm@40601
    40
Mercurial book http://hgbook.red-bean.com/ explains many more details.
wenzelm@40601
    41
wenzelm@40601
    42
Mercurial offers great flexibility in organizing the flow of changes,
wenzelm@40601
    43
both between individual developers and designated pull/push areas that
wenzelm@40601
    44
are shared with others.  This additional power demands some additional
wenzelm@40601
    45
responsibility to maintain a certain development process that fits to
wenzelm@40601
    46
a particular project.
wenzelm@28907
    47
wenzelm@40601
    48
Regular Mercurial operations are strictly monotonic, where changeset
wenzelm@40601
    49
transactions are only added, but never deleted.  There are special
wenzelm@40601
    50
tools to manipulate repositories via non-monotonic actions (such as
wenzelm@40601
    51
"rollback" or "strip"), but recovering from gross mistakes that have
wenzelm@40601
    52
escaped into the public can be hard and embarrassing.  It is much
wenzelm@40601
    53
easier to inspect and amend changesets routinely before pushing.
wenzelm@28907
    54
wenzelm@40601
    55
The effect of the critical "pull" / "push" operations can be tested in
wenzelm@40601
    56
a dry run via "incoming" / "outgoing".  The "fetch" extension includes
wenzelm@40601
    57
useful sanity checks beyond raw "pull" / "update" / "merge".  Most
wenzelm@40601
    58
other operations are local to the user's repository clone.  This gives
wenzelm@40601
    59
some freedom for experimentation without affecting anybody else.
wenzelm@40601
    60
wenzelm@40601
    61
Mercurial provides nice web presentation of incoming changes with a
wenzelm@40601
    62
digest of log entries; this also includes RSS/Atom news feeds.  There
wenzelm@47449
    63
are add-on history browsers such as "hg view" and TortoiseHg.  Unlike
wenzelm@47449
    64
the default web view, some of these tools help to inspect the semantic
wenzelm@47449
    65
content of non-trivial merge nodes.
wenzelm@28907
    66
wenzelm@28907
    67
wenzelm@28907
    68
Initial configuration
wenzelm@29481
    69
---------------------
wenzelm@28907
    70
wenzelm@28913
    71
The official Isabelle repository can be cloned like this:
wenzelm@28907
    72
wenzelm@28907
    73
  hg clone http://isabelle.in.tum.de/repos/isabelle
wenzelm@28907
    74
wenzelm@28907
    75
This will create a local directory "isabelle", unless an alternative
wenzelm@28907
    76
name is specified.  The full repository meta-data and history of
wenzelm@28907
    77
changes is in isabelle/.hg; local configuration for this clone can be
wenzelm@28907
    78
added to isabelle/.hg/hgrc, but note that hgrc files are never copied
wenzelm@40601
    79
by another clone operation.
wenzelm@28907
    80
wenzelm@28917
    81
wenzelm@28913
    82
There is also $HOME/.hgrc for per-user Mercurial configuration.  The
wenzelm@40601
    83
initial configuration requires at least an entry to identify yourself
wenzelm@40601
    84
as follows:
wenzelm@28907
    85
wenzelm@28907
    86
  [ui]
wenzelm@40601
    87
  username = XXX
wenzelm@28907
    88
wenzelm@40601
    89
Isabelle contributors are free to choose either a short "login name"
wenzelm@40601
    90
(for accounts at TU Munich) or a "full name" -- with or without mail
wenzelm@40601
    91
address.  It is important to stick to this choice once and for all.
wenzelm@40601
    92
The machine default that Mercurial produces for unspecified
wenzelm@40601
    93
[ui]username is not appropriate.
wenzelm@28907
    94
wenzelm@40601
    95
Such configuration can be given in $HOME/.hgrc (for each home
wenzelm@40601
    96
directory on each machine) or in .hg/hgrc (for each repository clone).
wenzelm@28907
    97
wenzelm@28907
    98
wenzelm@40601
    99
Here are some further examples for hgrc.  This is how to provide
wenzelm@40601
   100
default options for common commands:
wenzelm@28907
   101
wenzelm@28907
   102
  [defaults]
wenzelm@28907
   103
  log = -l 10
wenzelm@28907
   104
wenzelm@40601
   105
This is how to configure some extension, which is called "graphlog"
wenzelm@40601
   106
and provides the "glog" command:
wenzelm@28907
   107
wenzelm@28907
   108
  [extensions]
wenzelm@28907
   109
  hgext.graphlog =
wenzelm@28907
   110
wenzelm@28907
   111
wenzelm@28907
   112
Shared pull/push access
wenzelm@29481
   113
-----------------------
wenzelm@28907
   114
wenzelm@28907
   115
The entry point http://isabelle.in.tum.de/repos/isabelle is world
wenzelm@28907
   116
readable, both via plain web browsing and the hg client as described
wenzelm@40601
   117
above.  Anybody can produce a clone, change it locally, and then use
wenzelm@40601
   118
regular mechanisms of Mercurial to report changes upstream, say via
wenzelm@40601
   119
mail to someone with write access to that file space.  It is also
wenzelm@40601
   120
quite easy to publish changed clones again on the web, using the
wenzelm@40601
   121
ad-hoc command "hg serve -v", or the hgweb.cgi or hgwebdir.cgi scripts
wenzelm@40601
   122
that are included in the Mercurial distribution, and send a "pull
wenzelm@40601
   123
request" to someone else.  There are also public hosting services for
wenzelm@40601
   124
Mercurial repositories.
wenzelm@28907
   125
wenzelm@28913
   126
The downstream/upstream mode of operation is quite common in the
wenzelm@28907
   127
distributed version control community, and works well for occasional
wenzelm@28907
   128
changes produced by anybody out there.  Of course, upstream
wenzelm@28907
   129
maintainers need to review and moderate changes being proposed, before
wenzelm@40601
   130
pushing anything onto the official Isabelle repository at TUM.  Direct
wenzelm@40601
   131
pushes are also reviewed routinely in a post-hoc fashion; everybody
wenzelm@40601
   132
hooked on the main repository is called to keep an eye on incoming
wenzelm@40601
   133
changes.  In any case, changesets need to be understandable, at the
wenzelm@40601
   134
time of writing and many years later.
wenzelm@28907
   135
wenzelm@40601
   136
Push access to the Isabelle repository requires an account at TUM,
wenzelm@47449
   137
with properly configured ssh to the local machines (e.g. macbroy20 ..
wenzelm@47449
   138
macbroy29).  You also need to be a member of the "isabelle" Unix
wenzelm@40601
   139
group.
wenzelm@28907
   140
wenzelm@28913
   141
Sharing a locally modified clone then works as follows, using your
wenzelm@28913
   142
user name instead of "wenzelm":
wenzelm@28913
   143
wenzelm@47449
   144
  hg out ssh://wenzelm@macbroy20//home/isabelle-repository/repos/isabelle
wenzelm@28907
   145
wenzelm@28913
   146
In fact, the "out" or "outgoing" command performs only a dry run: it
wenzelm@28913
   147
displays the changesets that would get published.  An actual "push",
wenzelm@28913
   148
with a lasting effect on the Isabelle repository, works like this:
wenzelm@28907
   149
wenzelm@47449
   150
  hg push ssh://wenzelm@macbroy20//home/isabelle-repository/repos/isabelle
wenzelm@28913
   151
wenzelm@28907
   152
wenzelm@40601
   153
Default paths for push and pull can be configured in
wenzelm@40601
   154
isabelle/.hg/hgrc, for example:
wenzelm@28907
   155
wenzelm@28907
   156
  [paths]
wenzelm@47449
   157
  default = ssh://wenzelm@macbroy20//home/isabelle-repository/repos/isabelle
wenzelm@28907
   158
wenzelm@28913
   159
Now "hg pull" or "hg push" will use that shared file space, unless a
wenzelm@28913
   160
different URL is specified explicitly.
wenzelm@28913
   161
wenzelm@28913
   162
When cloning a repository, the default path is set to the initial
wenzelm@28913
   163
source URL.  So we could have cloned via that ssh URL in the first
wenzelm@28913
   164
place, to get exactly to the same point:
wenzelm@28913
   165
wenzelm@47449
   166
  hg clone ssh://wenzelm@macbroy20//home/isabelle-repository/repos/isabelle
wenzelm@28907
   167
wenzelm@28907
   168
wenzelm@40601
   169
Simple merges
wenzelm@40601
   170
-------------
wenzelm@30182
   171
wenzelm@30182
   172
The main idea of Mercurial is to let individual users produce
wenzelm@30182
   173
independent branches of development first, but merge with others
wenzelm@30182
   174
frequently.  The basic hg merge operation is more general than
wenzelm@30182
   175
required for the mode of operation with a shared pull/push area.  The
wenzelm@40601
   176
"fetch" extension accommodates this case nicely, automating trivial
wenzelm@30182
   177
merges and requiring manual intervention for actual conflicts only.
wenzelm@30182
   178
wenzelm@40601
   179
The fetch extension can be configured via $HOME/.hgrc like this:
wenzelm@30182
   180
wenzelm@30182
   181
  [extensions]
wenzelm@30182
   182
  hgext.fetch =
wenzelm@30182
   183
wenzelm@30182
   184
  [defaults]
wenzelm@30182
   185
  fetch = -m "merged"
wenzelm@30182
   186
wenzelm@40601
   187
To keep merges semantically trivial and prevent genuine merge
wenzelm@40601
   188
conflicts or lost updates, it is essential to observe to following
wenzelm@40601
   189
general discipline wrt. the public Isabelle push area:
wenzelm@40601
   190
wenzelm@40601
   191
  * Before editing, pull or fetch the latest version.
wenzelm@40601
   192
wenzelm@40601
   193
  * Accumulate private commits for a maximum of 1-3 days.
wenzelm@40601
   194
wenzelm@40601
   195
  * Start publishing again by pull or fetch, which normally produces
wenzelm@40601
   196
    local merges.
wenzelm@40601
   197
wenzelm@50281
   198
  * Test the merged result, e.g. like this:
wenzelm@50281
   199
wenzelm@50281
   200
      isabelle build -a
wenzelm@50281
   201
wenzelm@50281
   202
  * Push back in real time.
wenzelm@40601
   203
wenzelm@40601
   204
Piling private changes and public merges longer than 0.5-2 hours is
wenzelm@40601
   205
apt to produce some mess when pushing eventually!
wenzelm@30182
   206
wenzelm@50281
   207
The pull-test-push cycle should not be repeated too fast, to avoid
wenzelm@50281
   208
delaying others from doing the same concurrently.
wenzelm@50281
   209
wenzelm@30182
   210
wenzelm@28907
   211
Content discipline
wenzelm@29481
   212
------------------
wenzelm@28907
   213
wenzelm@40601
   214
The following principles should be kept in mind when producing
wenzelm@40601
   215
changesets that are meant to be published at some point.
wenzelm@28907
   216
wenzelm@40601
   217
  * The author of changes needs to be properly identified, using
wenzelm@40601
   218
    [ui]username configuration as described above.
wenzelm@28907
   219
wenzelm@28907
   220
    While Mercurial also provides means for signed changesets, we want
wenzelm@28907
   221
    to keep things simple and trust that users specify their identity
wenzelm@40601
   222
    correctly (and uniquely).
wenzelm@28907
   223
wenzelm@28907
   224
  * The history of sources is an integral part of the sources
wenzelm@28907
   225
    themselves.  This means that private experiments and branches
wenzelm@40601
   226
    should not be published by accident.  Named branches are not
wenzelm@40601
   227
    allowed on the public version.  Note that old SVN-style branching
wenzelm@40601
   228
    is replaced by regular repository clones in Mercurial.
wenzelm@28907
   229
wenzelm@40601
   230
    Exchanging local experiments with some other users can be done
wenzelm@40601
   231
    directly on peer-to-peer basis, without affecting the central
wenzelm@40601
   232
    pull/push area.
wenzelm@28907
   233
wenzelm@28907
   234
  * Log messages are an integral part of the history of sources.
wenzelm@40601
   235
    Other people will have to inspect them routinely, to understand
wenzelm@40601
   236
    why things have been done in a certain way at some point.
wenzelm@40601
   237
wenzelm@40601
   238
    Authors of log entries should be aware that published changes are
wenzelm@40601
   239
    actually read.  The main point is not to announce novelties, but
wenzelm@40601
   240
    to describe faithfully what has been done, and provide some clues
wenzelm@40601
   241
    about the motivation behind it.  The main recipient is someone who
wenzelm@40601
   242
    needs to understand the change in the distant future to isolate
wenzelm@40601
   243
    problems.  Sometimes it is helpful to reference past changes via
wenzelm@40601
   244
    changeset ids in the log entry.
wenzelm@28907
   245
wenzelm@40601
   246
  * The standard changelog entry format of the Isabelle repository
wenzelm@40601
   247
    admits several (vaguely related) items to be rolled into one
wenzelm@40601
   248
    changeset.  Each item is then described on a separate line that
wenzelm@40601
   249
    may become longer as screen line and is terminated by punctuation.
wenzelm@40601
   250
    These lines are roughly ordered by importance.
wenzelm@28907
   251
wenzelm@40601
   252
    This format conforms to established Isabelle tradition.  In
wenzelm@40601
   253
    contrast, the default of Mercurial prefers a single headline
wenzelm@40601
   254
    followed by a long body text.  The reason for that is a somewhat
wenzelm@40601
   255
    different development model of typical "distributed" projects,
wenzelm@40601
   256
    where external changes pass through a hierarchy of reviewers and
wenzelm@40601
   257
    maintainers, until they end up in some authoritative repository.
wenzelm@40601
   258
    Isabelle changesets can be more spontaneous, growing from the
wenzelm@40601
   259
    bottom-up.
wenzelm@40601
   260
wenzelm@40601
   261
    The web style of http://isabelle.in.tum.de/repos/isabelle/
wenzelm@40601
   262
    accommodates the Isabelle changelog format.  Note that multiple
wenzelm@40601
   263
    lines will sometimes display as a single paragraph in HTML, so
wenzelm@40601
   264
    some terminating punctuation is required.  Do not squeeze multiple
wenzelm@40601
   265
    items on the same line in the original text!
wenzelm@28907
   266
wenzelm@28907
   267
wenzelm@32361
   268
Building a repository version of Isabelle
wenzelm@32361
   269
-----------------------------------------
wenzelm@28908
   270
wenzelm@48986
   271
This first requires to resolve add-on components first, including the
wenzelm@48986
   272
ML system.  Some extra configuration is required to approximate some
wenzelm@48986
   273
of the system integration of official Isabelle releases from a
wenzelm@48986
   274
bare-bones repository snapshot.  The special directory Admin/ -- which
wenzelm@48986
   275
is absent in official releases -- might provide some further clues.
wenzelm@48497
   276
wenzelm@48844
   277
Here is a reasonably easy way to include important Isabelle components
wenzelm@48844
   278
on the spot:
wenzelm@48844
   279
wenzelm@48854
   280
  (1) The bash script ISABELLE_HOME_USER/etc/settings is augmented by
wenzelm@48844
   281
  some shell function invocations like this:
wenzelm@28908
   282
wenzelm@48844
   283
      init_components "$HOME/.isabelle/contrib" "$ISABELLE_HOME/Admin/components/main"
wenzelm@48844
   284
      init_components "$HOME/.isabelle/contrib" "$ISABELLE_HOME/Admin/components/optional"
wenzelm@48844
   285
wenzelm@48844
   286
  This uses some central place "$HOME/.isabelle/contrib" to keep
wenzelm@48844
   287
  component directories that are shared by all Isabelle versions.
wenzelm@48844
   288
wenzelm@48844
   289
  (2) Missing components are resolved on the command line like this:
wenzelm@48497
   290
wenzelm@48844
   291
      isabelle components -a
wenzelm@48844
   292
wenzelm@48844
   293
  This will saturate the "$HOME/.isabelle/contrib" directory structure
wenzelm@48855
   294
  according to $ISABELLE_COMPONENT_REPOSITORY.
wenzelm@48497
   295
wenzelm@48844
   296
Since the given component catalogs in $ISABELLE_HOME/Admin/components
wenzelm@48844
   297
are subject to the Mercurial history, it is possible to bisect over a
wenzelm@48844
   298
range of Isabelle versions while references to the contributing
wenzelm@48844
   299
components change accordingly.
wenzelm@48986
   300
wenzelm@48986
   301
The Isabelle build process is managed as follows:
wenzelm@48986
   302
wenzelm@48986
   303
  * regular "isabelle build" to build session images, e.g. HOL;
wenzelm@48986
   304
wenzelm@48986
   305
  * administrative "isabelle build_doc" to populate the doc/
wenzelm@48986
   306
    directory, such that "isabelle doc" will find the results.