diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/README.rst b/README.rst index 4ed283dd29..004d7b63d0 100644 --- a/README.rst +++ b/README.rst @@ -7,18 +7,17 @@ and how to build it. For information about Scala as a language, you can visit the web site http://www.scala-lang.org/ Part I. The repository layout --------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- Follows the file layout of the Scala repository. Files marked with a † are not part of the repository but are either automatically generated by the -build script or user-created if needed. This is not a complete listing. :: +build script or user-created if needed. This is not a complete listing. :: scala/ +--build/ Build products output directory for ant. +--build.xml The main Ant build script. +--dist/ The destination folder for Scala distributions. +--docs/ Documentation and sample code. +--lib/ Pre-compiled libraries for the build. - | +--fjbg.jar The Java byte-code generation library. | +--scala-compiler.jar The stable reference ('starr') compiler jar | +--scala-library.jar The stable reference ('starr') library jar | +--scala-library-src.jar A snapshot of the source used to build starr. @@ -68,7 +67,7 @@ description of the four layers that SABBUS uses, from bottom to top: - ``strap``: a test layer used to check stability of the build. ^^^^^^^^^^^^^^^^^^^^^^^^ - DEPENDANT CHANGES: + DEPENDENT CHANGES: ^^^^^^^^^^^^^^^^^^^^^^^^ SABBUS compiles, for each layer, the Scala library first and the compiler next. That means that any changes in the library can immediately be used in the @@ -111,12 +110,12 @@ Part III. Common use-cases - ``ln -s build/quick/bin qbin`` (once): - ``ant && qbin/scalac -d sandbox sandbox/test.scala && qbin/scala -cp sandbox Test`` - + Incrementally builds quick, and then uses it to compile and run the file ``sandbox/test.scala``. This is a typical debug cycle. - ``ant replacelocker`` - + "unfreezes" locker by updating it to match the current source code. - This will delete quick so as not to mix classes compiled with different @@ -137,7 +136,7 @@ Part III. Common use-cases ANT_OPTS="-Xms512M -Xmx2048M -Xss1M -XX:MaxPermSize=128M" ant docs - ``ant dist`` - + Builds a distribution. - Rebuilds locker from scratch (to make sure it bootstraps). |