mirror of https://github.com/sbt/sbt.git
notice+link to new locations on scala-sbt.org
Mark Harrah
parent
de0f333759
commit
8b6f67c920
|
|
@ -24,6 +24,11 @@
|
|||
[#472]: https://github.com/harrah/xsbt/pull/472
|
||||
[Launcher]: https://github.com/harrah/xsbt/wiki/Launcher
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Community/ChangeSummary_0.12.0>.
|
||||
|
||||
# 0.12.0 Changes
|
||||
|
||||
## Features, fixes, changes with compatibility implications (incomplete, please help)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,11 @@
|
|||
[Artifact API]: http://harrah.github.com/xsbt/latest/api/sbt/Artifact$.html
|
||||
[SettingsDefinition]: http://harrah.github.com/xsbt/latest/api/#sbt.Init$SettingsDefinition
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Artifacts>.
|
||||
|
||||
# Artifacts
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Best-Practices>.
|
||||
|
||||
# Best Practices
|
||||
|
||||
This page describes best practices for working with sbt.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[Attributed]: http://harrah.github.com/xsbt/latest/api/sbt/Attributed.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Classpaths>.
|
||||
|
||||
# Classpaths, sources, and resources
|
||||
|
||||
This page discusses how sbt builds up classpaths for different actions, like `compile`, `run`, and `test` and how to override or augment these classpaths.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Command-Line-Reference>.
|
||||
|
||||
# Command Line Reference
|
||||
|
||||
This page is a relatively complete list of command line options,
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Compiler-Plugins>.
|
||||
|
||||
# Compiler Plugin Support
|
||||
|
||||
There is some special support for using compiler plugins. You can set `auto-compiler-plugins` to `true` to enable this functionality.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Console-Project>.
|
||||
|
||||
# Console Project
|
||||
|
||||
# Description
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Cross-Build>.
|
||||
|
||||
# Cross-building
|
||||
|
||||
# Introduction
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/index>.
|
||||
|
||||
# Detailed Topic Pages
|
||||
|
||||
This part of the wiki has pages documenting particular sbt topics.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,11 @@
|
|||
[ForkScala]: http://harrah.github.com/xsbt/latest/api/sbt/Fork$.ForkScala.html
|
||||
[OutputStrategy]: http://harrah.github.com/xsbt/latest/api/sbt/OutputStrategy.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Forking>.
|
||||
|
||||
# Forking
|
||||
|
||||
By default, the `run` task runs in the same JVM as sbt. Forking is required under [[certain circumstances|Running Project Code]], however. Or, you might want to fork Java processes when implementing new tasks.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Global-Settings>.
|
||||
|
||||
# Global Settings
|
||||
|
||||
## Basic global configuration file
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Inspecting-Settings>.
|
||||
|
||||
# Using the Configuration System
|
||||
|
||||
Central to sbt is the new configuration system, which is designed to enable extensive customization.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Java-Sources>.
|
||||
|
||||
# Java Sources
|
||||
|
||||
sbt has support for compiling Java sources with the limitation that dependency tracking is limited to the dependencies present in compiled class files.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Launcher>.
|
||||
|
||||
# Launcher Specification
|
||||
|
||||
The sbt launcher component is a self-contained jar that boots a Scala application without Scala or the application already existing on the system. The only prerequisites are the launcher jar itself, an optional configuration file, and a java runtime version 1.6 or greater.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,11 @@
|
|||
[through Ivy]: http://ant.apache.org/ivy/history/latest-milestone/concept.html#checksum
|
||||
[ModuleID]: http://harrah.github.com/xsbt/latest/api/sbt/ModuleID.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Library-Management>.
|
||||
|
||||
# Library Management
|
||||
|
||||
There's now a
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Local-Scala>.
|
||||
|
||||
# Local Scala
|
||||
|
||||
To use a locally built Scala version, define the `scala-home` setting, which is of type `Option[File]`.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
[Path]: http://harrah.github.com/xsbt/latest/api/sbt/Path$.html
|
||||
[PathFinder]: http://harrah.github.com/xsbt/latest/api/sbt/PathFinder.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Mapping-Files>.
|
||||
|
||||
# Mapping Files
|
||||
|
||||
Tasks like `package`, `packageSrc`, and `packageDoc` accept mappings of type `Seq[(File, String)]` from an input file to the path to use in the resulting artifact (jar). Similarly, tasks that copy files accept mappings of type `Seq[(File, File)]` from an input file to the destination file. There are some methods on [PathFinder] and [Path] that can be useful for constructing the `Seq[(File, String)]` or `Seq[(File, File)]` sequences.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Migrating-from-sbt-0.7.x-to-0.10.x>.
|
||||
|
||||
# Migrating from 0.7.x
|
||||
|
||||
The assumption here is that you are familiar with sbt 0.7 but new to 0.12.
|
||||
|
||||
sbt 0.12's many new capabilities can be a bit overwhelming, but this page should help you migrate to 0.12 with a minimum of fuss.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[sbt.ConcurrentRestrictions]: https://github.com/harrah/xsbt/blob/v0.12.0/tasks/ConcurrentRestrictions.scala
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Parallel-Execution>.
|
||||
|
||||
# Task ordering
|
||||
|
||||
Task ordering is specified by declaring a task's inputs.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Parsing-Input>.
|
||||
|
||||
# Parsing and tab completion
|
||||
|
||||
This page describes the parser combinators in sbt.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,11 @@
|
|||
[Path]: http://harrah.github.com/xsbt/latest/api/sbt/Path$.html
|
||||
[IO]: http://harrah.github.com/xsbt/latest/api/sbt/IO$.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Paths>.
|
||||
|
||||
# Paths
|
||||
|
||||
This page describes files, sequences of files, and file filters. The base type used is [java.io.File], but several methods are augmented through implicits:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[ProcessBuilder API]: http://harrah.github.com/xsbt/latest/api/sbt/ProcessBuilder.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Process>.
|
||||
|
||||
# External Processes
|
||||
|
||||
# Usage
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Publishing>.
|
||||
|
||||
# Publish
|
||||
|
||||
This page describes how to publish your project. Publishing consists of uploading a descriptor, such as an Ivy file or Maven POM, and artifacts, such as a jar or war, to a repository so that other projects can specify your project as a dependency.
|
||||
|
|
|
|||
|
|
@ -13,6 +13,11 @@
|
|||
[url factory]: http://harrah.github.com/xsbt/latest/api/sbt/Resolver$$url$.html
|
||||
[URLRepository API]: http://harrah.github.com/xsbt/latest/api/sbt/URLRepository.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Resolvers>.
|
||||
|
||||
# Resolvers
|
||||
|
||||
## Maven
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Running-Project-Code>.
|
||||
|
||||
# Running Project Code
|
||||
|
||||
The `run` and `console` actions provide a means for running user code in the same virtual machine as sbt. This page describes the problems with doing so, how sbt handles these problems, what types of code can use this feature, and what types of code must use a [[forked jvm|Forking]]. Skip to User Code if you just want to see when you should use a [[forked jvm|Forking]].
|
||||
|
|
|
|||
|
|
@ -2,6 +2,11 @@
|
|||
[conscript]: https://github.com/n8han/conscript
|
||||
[setup script]: https://github.com/paulp/xsbtscript
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Scripts>.
|
||||
|
||||
# Scripts, REPL, and Dependencies
|
||||
|
||||
sbt has two alternative entry points that may be used to:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Setup-Notes>.
|
||||
|
||||
# Setup Notes
|
||||
|
||||
Some notes on how to set up your `sbt` script.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/TaskInputs>.
|
||||
|
||||
# Task Inputs/Dependencies
|
||||
|
||||
Tasks with dependencies are now introduced in the
|
||||
|
|
|
|||
|
|
@ -3,6 +3,11 @@
|
|||
[Incomplete]: https://github.com/harrah/xsbt/latest/api/sbt/Incomplete.html
|
||||
[Result]: https://github.com/harrah/xsbt/latest/api/sbt/Result.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Tasks>.
|
||||
|
||||
# Tasks
|
||||
|
||||
Tasks and settings are now introduced in the
|
||||
|
|
|
|||
|
|
@ -6,6 +6,11 @@
|
|||
[specs2]: http://etorreborre.github.com/specs2/
|
||||
[ScalaTest]: http://www.artima.com/scalatest/
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Testing>.
|
||||
|
||||
# Testing
|
||||
|
||||
# Basics
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[web plugin]: https://github.com/siasia/xsbt-web-plugin
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Triggered-Execution>.
|
||||
|
||||
# Triggered Execution
|
||||
|
||||
You can make a command run when certain files change by prefixing the command with `~`. Monitoring is terminated when `enter` is pressed. This triggered execution is configured by the `watch` setting, but typically the basic settings `watch-sources` and `poll-interval` are modified.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,11 @@
|
|||
[ModuleFilter]: http://harrah.github.com/xsbt/latest/api/sbt/ModuleFilter.html
|
||||
[ArtifactFilter]: http://harrah.github.com/xsbt/latest/api/sbt/ArtifactFilter.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Update-Report>.
|
||||
|
||||
# Update Report
|
||||
|
||||
`update` and related tasks produce a value of type [sbt.UpdateReport]
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
Why could I?
|
||||
|
||||
Unfortunately, the GitHub wiki only provides two roles. One can't modify anything while the other can edit, delete, or create new pages. The delete page link doesn't ask for confirmation and so we get pages accidentally deleted. We have to live with it if we want to allow users to edit the wiki (and we do). Don't worry about it and thanks for promptly reverting.
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Examples/Advanced-Command-Example>.
|
||||
|
||||
# Advanced Command Example
|
||||
|
||||
This is an advanced example showing some of the power of the new settings system. It shows how to temporarily modify all declared dependencies in the build, regardless of where they are defined. It directly operates on the final Seq[Setting[_]] produced from every setting involved in the build.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Examples/Advanced-Configurations-Example>.
|
||||
|
||||
## Advanced Configurations Example
|
||||
|
||||
This is an example [[full build definition|Full Configuration]] that demonstrates using Ivy configurations to group dependencies.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Examples/index>.
|
||||
|
||||
# Examples
|
||||
|
||||
This section of the wiki has example sbt build definitions and
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Examples/Full-Configuration-Example>.
|
||||
|
||||
## Full Configuration Example
|
||||
|
||||
Full configurations are written in Scala, so this example would be placed as project/Build.scala, not build.sbt. The build can be split into multiple files.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Examples/Quick-Configuration-Examples>.
|
||||
|
||||
[sbt.SettingDefinition]: http://harrah.github.com/xsbt/latest/api/sbt/Init$SettingsDefinition.html
|
||||
|
||||
Listed here are some examples of settings (each setting is
|
||||
|
|
|
|||
|
|
@ -7,6 +7,10 @@
|
|||
[ProjectRef]: http://harrah.github.com/xsbt/latest/api/sbt/ProjectRef.html
|
||||
[ClasspathDep]: http://harrah.github.com/xsbt/latest/api/sbt/ClasspathDep.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Build-Loaders>.
|
||||
|
||||
# Build Loaders
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,11 @@
|
|||
[ResolvedProject]: http://harrah.github.com/xsbt/latest/api/sbt/ResolvedProject.html
|
||||
[ProjectReferences]: http://harrah.github.com/xsbt/latest/api/sbt/ProjectReference.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Build-State>.
|
||||
|
||||
# State and actions
|
||||
|
||||
[State] is the entry point to all available information in sbt.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[xsbti.AppMain]: http://harrah.github.com/xsbt/latest/api/xsbti/AppMain.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Command-Line-Applications>.
|
||||
|
||||
# Creating Command Line Applications Using sbt
|
||||
|
||||
There are several components of sbt that may be used to create a command line application.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
[State]: http://harrah.github.com/xsbt/latest/api/sbt/State.html
|
||||
[Command.scala]: http://harrah.github.com/xsbt/latest/sxr/Command.scala.html#10761
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Commands>.
|
||||
|
||||
# Commands
|
||||
|
||||
# What is a "command"?
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/index>.
|
||||
|
||||
# Extending sbt
|
||||
|
||||
This part of the wiki has pages documenting sbt "internals,"
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[InputTask.apply]: http://harrah.github.com/xsbt/latest/api/sbt/InputTask$.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Input-Tasks>.
|
||||
|
||||
# Input Tasks
|
||||
|
||||
Input Tasks parse user input and produce a task to run. [[Parsing Input]] describes how to use the parser combinators that define the input syntax and tab completion. This page describes how to hook those parser combinators into the input task system.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Plugins-Best-Practices>.
|
||||
|
||||
# Plugins Best Practices
|
||||
|
||||
_This page is intended primarily for SBT plugin authors._
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Plugins>.
|
||||
|
||||
# Plugins
|
||||
|
||||
# Introduction
|
||||
|
|
|
|||
|
|
@ -3,6 +3,11 @@
|
|||
[Select]: http://harrah.github.com/xsbt/latest/api/sbt/Select.html
|
||||
[main/Structure.scala]: https://github.com/harrah/xsbt/blob/0.12/main/Structure.scala
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Extending/Settings-Core>.
|
||||
|
||||
# Settings Core
|
||||
|
||||
This page describes the core settings engine a bit. This may be useful for using it outside of sbt. It may also be useful for understanding how sbt works internally.
|
||||
|
|
|
|||
5
FAQ.md
5
FAQ.md
|
|
@ -26,6 +26,11 @@
|
|||
|
||||
# Frequently Asked Questions
|
||||
|
||||
## Docucmentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for the FAQ is <http://scala-sbt.org/release/docs/faq>.
|
||||
|
||||
## Project Information
|
||||
|
||||
### How do I get help?
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[Keys]: http://harrah.github.com/xsbt/latest/sxr/Keys.scala.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Basic-Def>.
|
||||
|
||||
# `.sbt` Build Definition
|
||||
|
||||
[[Previous|Getting Started Running]] _Getting Started Guide page 6 of 14._ [[Next|Getting Started Scopes]]
|
||||
|
|
|
|||
|
|
@ -2,6 +2,11 @@
|
|||
[Defaults]: http://harrah.github.com/xsbt/latest/sxr/Defaults.scala.html "Defaults.scala"
|
||||
[IO]: http://harrah.github.com/xsbt/latest/api/index.html#sbt.IO$ "IO object"
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Custom-Settings>.
|
||||
|
||||
# Custom Settings and Tasks
|
||||
|
||||
[[Previous|Getting Started Multi-Project]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[Maven]: http://maven.apache.org/
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Directories>.
|
||||
|
||||
# Directory structure
|
||||
|
||||
[[Previous|Getting Started Hello]] _Getting Started Guide page 4 of 14._ [[Next|Getting Started Running]]
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Full-Def>.
|
||||
|
||||
# `.scala` Build Definition
|
||||
|
||||
[[Previous|Getting Started Library Dependencies]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Hello>.
|
||||
|
||||
# Hello, World
|
||||
|
||||
[[Previous|Getting Started Setup]] _Getting Started Guide page 3 of 14._ [[Next|Getting Started Directories]]
|
||||
|
|
|
|||
|
|
@ -7,6 +7,11 @@
|
|||
[specs]: http://code.google.com/p/specs/
|
||||
[ScalaTest]: http://www.scalatest.org/
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Library-Dependencies>.
|
||||
|
||||
# Library Dependencies
|
||||
|
||||
[[Previous|Getting Started More About Settings]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
[Keys]: http://harrah.github.com/xsbt/latest/sxr/Keys.scala.html "Keys.scala"
|
||||
[ScopedSetting]: http://harrah.github.com/xsbt/latest/api/sbt/ScopedSetting.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/More-About-Settings>.
|
||||
|
||||
# More Kinds of Setting
|
||||
|
||||
[[Previous|Getting Started Scopes]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Multi-Project>.
|
||||
|
||||
# Multi-Project Builds
|
||||
|
||||
[[Previous|Getting Started Using Plugins]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Running>.
|
||||
|
||||
# Running
|
||||
|
||||
[[Previous|Getting Started Directories]] _Getting Started Guide page 5 of 14._ [[Next|Getting Started Basic Def]]
|
||||
|
|
|
|||
|
|
@ -2,6 +2,11 @@
|
|||
http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Dependency_Scope
|
||||
"Maven scopes"
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Scopes>.
|
||||
|
||||
# Scopes
|
||||
|
||||
[[Previous|Getting Started Basic Def]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
[sbt-launch.jar]: http://typesafe.artifactoryonline.com/typesafe/ivy-releases/org.scala-sbt/sbt-launch/0.12.0/sbt-launch.jar
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Setup>.
|
||||
|
||||
# Setup
|
||||
|
||||
[[Previous|Getting Started Welcome]] _Getting Started Guide page 2 of 14._ [[Next|Getting Started Hello]]
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Summary>.
|
||||
|
||||
# Getting Started Summary
|
||||
|
||||
[[Previous|Getting Started Custom Settings]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Using-Plugins>.
|
||||
|
||||
# Using Plugins
|
||||
|
||||
[[Previous|Getting Started Full Def]] _Getting Started Guide page
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Getting-Started/Welcome>.
|
||||
|
||||
# Welcome!
|
||||
|
||||
_Getting Started Guide page 1 of 14._ [[Next|Getting Started Setup]]
|
||||
|
|
|
|||
40
Home.md
40
Home.md
|
|
@ -1,41 +1,5 @@
|
|||
sbt is a build tool for Scala and Java projects that aims to do the basics well. It requires Java 1.6 or later.
|
||||
|
||||
## Install
|
||||
# Documentation has moved
|
||||
|
||||
See the [[install instructions|Getting Started Setup]].
|
||||
|
||||
## Features
|
||||
* Easy to set up for simple projects
|
||||
* [[.sbt build definition|Getting Started Basic Def]] uses a Scala-based "domain-specific language" (DSL)
|
||||
* More advanced [[.scala build definitions|Getting Started Full Def]] and [[extensions|Getting Started Custom Settings]] use the full flexibility of unrestricted Scala code
|
||||
* Accurate incremental recompilation using information extracted from the compiler
|
||||
* Continuous compilation and testing with [[triggered execution|Triggered Execution]]
|
||||
* Packages and publishes jars
|
||||
* Generates documentation with scaladoc
|
||||
* Supports mixed Scala/[[Java|Java Sources]] projects
|
||||
* Supports [[Testing|testing]] with ScalaCheck, specs, and ScalaTest (JUnit is supported by a plugin)
|
||||
* Starts the Scala REPL with project classes and dependencies on the classpath
|
||||
* [[Sub-project|Getting Started Multi-Project]] support (put multiple packages in one project)
|
||||
* External project support (list a git repository as a dependency!)
|
||||
* Parallel task execution, including parallel test execution
|
||||
* [[Library management support|Getting Started Library Dependencies]]: inline declarations, external Ivy or Maven configuration files, or manual management
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started, read the
|
||||
[[Getting Started Guide|Getting Started Welcome]].
|
||||
|
||||
_Please read the
|
||||
[[Getting Started Guide|Getting Started Welcome]]._ You will save
|
||||
yourself a _lot_ of time if you have the right understanding of
|
||||
the big picture up-front.
|
||||
|
||||
If you are familiar with 0.7.x, please see the
|
||||
[[migration page|Migrating from sbt 0.7.x to 0.10.x]]. Documentation for
|
||||
0.7.x is still available on the
|
||||
[Google Code Site](http://code.google.com/p/simple-build-tool/wiki/DocumentationHome).
|
||||
This wiki applies to sbt 0.10 and later.
|
||||
|
||||
The mailing list is at <http://groups.google.com/group/simple-build-tool/topics>. Please use it for questions and comments!
|
||||
|
||||
This wiki is editable if you have a GitHub account. Feel free to make corrections and add documentation. Use the mailing list if you have questions or comments.
|
||||
The documentation for sbt is now located at <http://scala-sbt.org>.
|
||||
|
|
|
|||
5
Index.md
5
Index.md
|
|
@ -30,6 +30,11 @@
|
|||
[State]: http://harrah.github.com/xsbt/latest/api/sbt/State.html
|
||||
[Task]: http://harrah.github.com/xsbt/latest/api/sbt/Task.html
|
||||
|
||||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Name-Index>.
|
||||
|
||||
# Index
|
||||
|
||||
This is an index of common methods, types, and values you might find in an sbt build definition.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
|
||||
## Resources
|
||||
|
||||
Here is gathered a few other places with SBT information:
|
||||
|
||||
* Josh Suereth's [SBT Introduction & Cookbook](http://www.youtube.com/watch?v=vED2LMbdFDc) and [slides](https://docs.google.com/present/view?id=dfqn4jb_115x89dq2dg&pli=)
|
||||
|
|
|
|||
1
Setup.md
1
Setup.md
|
|
@ -1 +0,0 @@
|
|||
ttt
|
||||
|
|
@ -1,3 +1,10 @@
|
|||
# Documentation has moved
|
||||
|
||||
The documentation for sbt has moved to <http://scala-sbt.org>.
|
||||
The new location for this page is <http://scala-sbt.org/release/docs/Detailed-Topics/Understanding-incremental-recompilation>.
|
||||
|
||||
## Introduction
|
||||
|
||||
Compiling Scala code is slow, and SBT makes it often faster. By understanding how, you can even understand how to make compilation even faster. Modifying source files with many dependencies might require recompiling only those source files—which might take, say, 5 seconds—instead of all the dependencies—which might take, say, 2 minutes. Often you can control which will be your case and make development much faster by some simple coding practices.
|
||||
|
||||
In fact, improving Scala compilation times is one major goal of SBT, and conversely the speedups it gives are one of the major motivations to use it. A significant portion of SBT sources and development efforts deals with strategies for speeding up compilation.
|
||||
|
|
|
|||
Loading…
Reference in New Issue