diff --git a/src/sphinx/Getting-Started/Basic-Def.rst b/src/sphinx/Getting-Started/Basic-Def.rst index 77a538c53..ee56a9cfc 100644 --- a/src/sphinx/Getting-Started/Basic-Def.rst +++ b/src/sphinx/Getting-Started/Basic-Def.rst @@ -35,8 +35,7 @@ of your project. *Build definition files do not affect sbt's map directly.* Instead, the build definition creates a huge list of objects with type -``Setting[T]`` where ``T`` is the type of the value in the map. (Scala's -``Setting[T]`` is like ``Setting`` in Java.) A ``Setting`` describes +``Setting[T]`` where ``T`` is the type of the value in the map. A ``Setting`` describes a *transformation to the map*, such as adding a new key-value pair or appending to an existing value. (In the spirit of functional programming, a transformation returns a new map, it does not update the @@ -88,6 +87,7 @@ The expressions in ``build.sbt`` are independent of one another, and they are expressions, rather than complete Scala statements. These expressions may be interspersed with ``val``s, ``lazy val``s, and ``def``s, but top-level ``object``s and classes are not allowed in ``build.sbt``. +Those should go in the ``project/`` directory as full Scala source files. On the left, ``name``, ``version``, and ``scalaVersion`` are *keys*. A key is an instance of ``SettingKey[T]``, ``TaskKey[T]``, or @@ -116,7 +116,8 @@ If you use the wrong value type, the build definition will not compile: name := 42 // will not compile -### Settings are separated by blank lines +Settings are separated by blank lines +------------------------------------- You can't write a ``build.sbt`` like this: diff --git a/src/sphinx/Getting-Started/Hello.rst b/src/sphinx/Getting-Started/Hello.rst index 5f3f194a0..875e7545a 100644 --- a/src/sphinx/Getting-Started/Hello.rst +++ b/src/sphinx/Getting-Started/Hello.rst @@ -83,7 +83,7 @@ You can force a particular version of sbt by creating a file sbt.version=0.13.0 -sbt is 99% source compatible from release to release. +to force the use of sbt 0.13.0. sbt is 99% source compatible from release to release. Still, setting the sbt version in ``project/build.properties`` avoids any potential confusion. diff --git a/src/sphinx/Getting-Started/Setup.rst b/src/sphinx/Getting-Started/Setup.rst index 22e142094..a8f13189a 100644 --- a/src/sphinx/Getting-Started/Setup.rst +++ b/src/sphinx/Getting-Started/Setup.rst @@ -36,25 +36,6 @@ Please report any issues to the sbt-launcher-package_ project. You may also try out the `Manual Installation`_. -Gentoo ------- - -In official tree there is no ebuild for sbt. But there are ebuilds to -merge sbt from binaries: -https://github.com/whiter4bbit/overlays/tree/master/dev-java/sbt-bin. To -merge sbt from this ebuilds you can do next: - -.. code-block:: console - - $ mkdir -p /usr/local/portage && cd /usr/local/portage - $ git clone git://github.com/whiter4bbit/overlays.git - $ echo "PORTDIR_OVERLAY=$PORTDIR_OVERLAY /usr/local/portage/overlays" >> /etc/make.conf - $ emerge sbt-bin - -.. note:: - - Please report any issues with the ebuild `here `_. - Mac --- @@ -74,6 +55,26 @@ Or `HomeBrew `_: Please make sure to report any issues with these packages to the relevant maintainers. + +Gentoo +------ + +In official tree there is no ebuild for sbt. But there are ebuilds to +merge sbt from binaries: +https://github.com/whiter4bbit/overlays/tree/master/dev-java/sbt-bin. To +merge sbt from this ebuilds you can do next: + +.. code-block:: console + + $ mkdir -p /usr/local/portage && cd /usr/local/portage + $ git clone git://github.com/whiter4bbit/overlays.git + $ echo "PORTDIR_OVERLAY=$PORTDIR_OVERLAY /usr/local/portage/overlays" >> /etc/make.conf + $ emerge sbt-bin + +.. note:: + + Please report any issues with the ebuild `here `_. + Manual Installation ------------------- @@ -116,12 +117,6 @@ Tips and Notes If you have any trouble running ``sbt``, see :doc:`/Detailed-Topics/Setup-Notes` on terminal encodings, HTTP proxies, and JVM options. -To install sbt, you could also use this fairly elaborated shell script: -https://github.com/paulp/sbt-extras (see sbt file in the root dir). It -has the same purpose as the simple shell script above but it will -install sbt if necessary. It knows all recent versions of sbt and it -also comes with a lot of useful command line options. - Next ----