README_REPOSITORY
changeset 51502 ed5d96d01b2f
parent 51072 0351cc781a26
child 51597 c916828edc92
     1.1 --- a/README_REPOSITORY	Sun Mar 24 12:07:31 2013 +0100
     1.2 +++ b/README_REPOSITORY	Sun Mar 24 14:26:10 2013 +0100
     1.3 @@ -22,6 +22,8 @@
     1.4  
     1.5      ./bin/isabelle jedit -l HOL
     1.6  
     1.7 +    ./bin/isabelle build -b HOL  #optional: build session image manually
     1.8 +
     1.9  3. Update repository (bash shell commands):
    1.10  
    1.11      cd isabelle
    1.12 @@ -32,6 +34,14 @@
    1.13  
    1.14      ./bin/isabelle jedit -l HOL
    1.15  
    1.16 +    ./bin/isabelle jedit -b -f  #optional: force fresh build of Isabelle/Scala
    1.17 +
    1.18 +4. Access documentation (bash shell commands):
    1.19 +
    1.20 +    ./bin/isabelle build_doc -p -a
    1.21 +
    1.22 +    ./bin/isabelle doc system
    1.23 +
    1.24  
    1.25  Introduction
    1.26  ------------
    1.27 @@ -50,17 +60,18 @@
    1.28  a particular project.
    1.29  
    1.30  Regular Mercurial operations are strictly monotonic, where changeset
    1.31 -transactions are only added, but never deleted.  There are special
    1.32 -tools to manipulate repositories via non-monotonic actions (such as
    1.33 -"rollback" or "strip"), but recovering from gross mistakes that have
    1.34 -escaped into the public can be hard and embarrassing.  It is much
    1.35 -easier to inspect and amend changesets routinely before pushing.
    1.36 +transactions are only added, but never deleted or mutated.  There are
    1.37 +special tools to manipulate repositories via non-monotonic actions
    1.38 +(such as "rollback" or "strip"), but recovering from gross mistakes
    1.39 +that have escaped into the public can be hard and embarrassing.  It is
    1.40 +much easier to inspect and amend changesets routinely before pushing.
    1.41  
    1.42  The effect of the critical "pull" / "push" operations can be tested in
    1.43  a dry run via "incoming" / "outgoing".  The "fetch" extension includes
    1.44 -useful sanity checks beyond raw "pull" / "update" / "merge".  Most
    1.45 -other operations are local to the user's repository clone.  This gives
    1.46 -some freedom for experimentation without affecting anybody else.
    1.47 +useful sanity checks beyond raw "pull" / "update" / "merge", although
    1.48 +it has lost popularity in recent years.  Most other operations are
    1.49 +local to the user's repository clone.  This gives some freedom for
    1.50 +experimentation without affecting anybody else.
    1.51  
    1.52  Mercurial provides nice web presentation of incoming changes with a
    1.53  digest of log entries; this also includes RSS/Atom news feeds.  There
    1.54 @@ -72,7 +83,7 @@
    1.55  Initial configuration
    1.56  ---------------------
    1.57  
    1.58 -The official Isabelle repository can be cloned like this:
    1.59 +The main Isabelle repository can be cloned like this:
    1.60  
    1.61    hg clone http://isabelle.in.tum.de/repos/isabelle
    1.62  
    1.63 @@ -125,7 +136,7 @@
    1.64  ad-hoc command "hg serve -v", or the hgweb.cgi or hgwebdir.cgi scripts
    1.65  that are included in the Mercurial distribution, and send a "pull
    1.66  request" to someone else.  There are also public hosting services for
    1.67 -Mercurial repositories.
    1.68 +Mercurial repositories, notably Bitbucket.
    1.69  
    1.70  The downstream/upstream mode of operation is quite common in the
    1.71  distributed version control community, and works well for occasional
    1.72 @@ -134,8 +145,8 @@
    1.73  pushing anything onto the official Isabelle repository at TUM.  Direct
    1.74  pushes are also reviewed routinely in a post-hoc fashion; everybody
    1.75  hooked on the main repository is called to keep an eye on incoming
    1.76 -changes.  In any case, changesets need to be understandable, at the
    1.77 -time of writing and many years later.
    1.78 +changes.  In any case, changesets need to be understandable, both at
    1.79 +the time of writing and many years later.
    1.80  
    1.81  Push access to the Isabelle repository requires an account at TUM,
    1.82  with properly configured ssh to isabelle-server.in.tum.de.  You also
    1.83 @@ -243,11 +254,11 @@
    1.84      to describe faithfully what has been done, and provide some clues
    1.85      about the motivation behind it.  The main recipient is someone who
    1.86      needs to understand the change in the distant future to isolate
    1.87 -    problems.  Sometimes it is helpful to reference past changes via
    1.88 -    changeset ids in the log entry.
    1.89 +    problems.  Sometimes it is helpful to reference past changes
    1.90 +    formally via changeset ids in the log entry.
    1.91  
    1.92    * The standard changelog entry format of the Isabelle repository
    1.93 -    admits several (vaguely related) items to be rolled into one
    1.94 +    admits several (somehow related) items to be rolled into one
    1.95      changeset.  Each item is then described on a separate line that
    1.96      may become longer as screen line and is terminated by punctuation.
    1.97      These lines are roughly ordered by importance.
    1.98 @@ -268,47 +279,32 @@
    1.99      items on the same line in the original text!
   1.100  
   1.101  
   1.102 -Building a repository version of Isabelle
   1.103 ------------------------------------------
   1.104 -
   1.105 -This first requires to resolve add-on components first, including the
   1.106 -ML system.  Some extra configuration is required to approximate some
   1.107 -of the system integration of official Isabelle releases from a
   1.108 -bare-bones repository snapshot.  The special directory Admin/ -- which
   1.109 -is absent in official releases -- might provide some further clues.
   1.110 +Testing of changes (before push)
   1.111 +--------------------------------
   1.112  
   1.113 -Here is a reasonably easy way to include important Isabelle components
   1.114 -on the spot:
   1.115 -
   1.116 -  (1) The bash script ISABELLE_HOME_USER/etc/settings is augmented by
   1.117 -  some shell function invocations like this:
   1.118 +The integrity of the standard pull/push area of Isabelle needs the be
   1.119 +preserved at all time.  This means that a complete test with default
   1.120 +configuration needs to be finished successfully before push.  If the
   1.121 +preparation of the push involves a pull/merge phase, its result needs
   1.122 +to covered by the test as well.
   1.123  
   1.124 -      init_components "$HOME/.isabelle/contrib" "$ISABELLE_HOME/Admin/components/main"
   1.125 -      init_components "$HOME/.isabelle/contrib" "$ISABELLE_HOME/Admin/components/optional"
   1.126 +There are several possibilities to perform the test, e.g. using the
   1.127 +Isabelle testboard at TUM.  In contrast, the subsequent command-line
   1.128 +examples are for tests on the local machine:
   1.129  
   1.130 -  This uses some central place "$HOME/.isabelle/contrib" to keep
   1.131 -  component directories that are shared by all Isabelle versions.
   1.132 +  ./bin/isabelle build -a  #regular test
   1.133  
   1.134 -  (2) Missing components are resolved on the command line like this:
   1.135 -
   1.136 -      isabelle components -a
   1.137 +  ./bin/isabelle build -a -o document=pdf  #test with document preparation
   1.138  
   1.139 -  This will saturate the "$HOME/.isabelle/contrib" directory structure
   1.140 -  according to $ISABELLE_COMPONENT_REPOSITORY.
   1.141 +  ./bin/isabelle build -a -j2 -o threads=4  #test on multiple cores (example)
   1.142  
   1.143 -Since the given component catalogs in $ISABELLE_HOME/Admin/components
   1.144 -are subject to the Mercurial history, it is possible to bisect over a
   1.145 -range of Isabelle versions while references to the contributing
   1.146 -components change accordingly.
   1.147 +See also the chapter on Isabelle sessions and build management in the
   1.148 +"system" manual.
   1.149  
   1.150 -The Isabelle build process is managed as follows:
   1.151 -
   1.152 -  * regular "isabelle build" to build session images, for example:
   1.153 -
   1.154 -      isabelle build -b HOL
   1.155 -
   1.156 -  * administrative "isabelle build_doc" to populate the doc/
   1.157 -    directory, such that "isabelle doc" will find the results, for example:
   1.158 -
   1.159 -      isabelle build_doc -p IsarRef
   1.160 -
   1.161 +Note that implicit dependencies on Isabelle components are specified
   1.162 +via catalog files in $ISABELLE_HOME/Admin/components/ as part of the
   1.163 +Mercurial history.  This allows to bisect over a range of Isabelle
   1.164 +versions while references to the contributing components change
   1.165 +accordingly.  Recall that "isabelle components -a" updates the local
   1.166 +component store monotonically according to that information, and thus
   1.167 +resolves missing components.