From 8b6f67c92070c94876b4888cc65708e7d48bb7f5 Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Tue, 9 Oct 2012 18:39:30 -0400 Subject: [PATCH] notice+link to new locations on scala-sbt.org --- ChangeSummary_0.12.0.md | 5 +++ Detailed-Topics/Artifacts.md | 5 +++ Detailed-Topics/Best-Practices.md | 5 +++ Detailed-Topics/Classpaths.md | 5 +++ Detailed-Topics/Command-Line-Reference.md | 5 +++ Detailed-Topics/Compiler-Plugins.md | 5 +++ Detailed-Topics/Console-Project.md | 5 +++ Detailed-Topics/Cross-Build.md | 5 +++ Detailed-Topics/Detailed-Topics.md | 5 +++ Detailed-Topics/Forking.md | 5 +++ Detailed-Topics/Global-Settings.md | 5 +++ Detailed-Topics/Inspecting-Settings.md | 5 +++ Detailed-Topics/Java-Sources.md | 5 +++ Detailed-Topics/Launcher.md | 5 +++ Detailed-Topics/Library-Management.md | 5 +++ Detailed-Topics/Local-Scala.md | 5 +++ Detailed-Topics/Mapping-Files.md | 5 +++ .../Migrating-from-SBT-0.7.x-to-0.10.x.md | 7 ++++ Detailed-Topics/Parallel-Execution.md | 5 +++ Detailed-Topics/Parsing-Input.md | 5 +++ Detailed-Topics/Paths.md | 5 +++ Detailed-Topics/Process.md | 5 +++ Detailed-Topics/Publishing.md | 5 +++ Detailed-Topics/Resolvers.md | 5 +++ Detailed-Topics/Running-Project-Code.md | 5 +++ Detailed-Topics/Scripts.md | 5 +++ Detailed-Topics/Setup-Notes.md | 5 +++ Detailed-Topics/TaskInputs.md | 5 +++ Detailed-Topics/Tasks.md | 5 +++ Detailed-Topics/Testing.md | 5 +++ Detailed-Topics/Triggered-Execution.md | 5 +++ Detailed-Topics/Update-Report.md | 5 +++ Did-not-mean-to-delete-this....md | 3 -- Examples/Advanced-Command-Example.md | 5 +++ Examples/Advanced-Configurations-Example.md | 5 +++ Examples/Examples.md | 5 +++ Examples/Full-Configuration-Example.md | 5 +++ Examples/Quick-Configuration-Examples.md | 5 +++ Extending/Build-Loaders.md | 4 ++ Extending/Build-State.md | 5 +++ Extending/Command-Line-Applications.md | 5 +++ Extending/Commands.md | 5 +++ Extending/Extending.md | 5 +++ Extending/Input-Tasks.md | 5 +++ Extending/Plugins-Best-Practices.md | 5 +++ Extending/Plugins.md | 5 +++ Extending/Settings-Core.md | 5 +++ FAQ.md | 5 +++ Getting-Started/Getting-Started-Basic-Def.md | 5 +++ .../Getting-Started-Custom-Settings.md | 5 +++ .../Getting-Started-Directories.md | 5 +++ Getting-Started/Getting-Started-Full-Def.md | 5 +++ Getting-Started/Getting-Started-Hello.md | 5 +++ .../Getting-Started-Library-Dependencies.md | 5 +++ .../Getting-Started-More-About-Settings.md | 5 +++ .../Getting-Started-Multi-Project.md | 5 +++ Getting-Started/Getting-Started-Running.md | 5 +++ Getting-Started/Getting-Started-Scopes.md | 5 +++ Getting-Started/Getting-Started-Setup.md | 5 +++ Getting-Started/Getting-Started-Summary.md | 5 +++ .../Getting-Started-Using-Plugins.md | 5 +++ Getting-Started/Getting-Started-Welcome.md | 5 +++ Home.md | 40 +------------------ Index.md | 5 +++ Resources.md | 6 +++ Setup.md | 1 - Understanding-incremental-recompilation.md | 7 ++++ 67 files changed, 326 insertions(+), 42 deletions(-) delete mode 100644 Did-not-mean-to-delete-this....md delete mode 100644 Setup.md diff --git a/ChangeSummary_0.12.0.md b/ChangeSummary_0.12.0.md index 5fba5fb..7183a6c 100644 --- a/ChangeSummary_0.12.0.md +++ b/ChangeSummary_0.12.0.md @@ -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 . +The new location for this page is . + # 0.12.0 Changes ## Features, fixes, changes with compatibility implications (incomplete, please help) diff --git a/Detailed-Topics/Artifacts.md b/Detailed-Topics/Artifacts.md index 35c6c47..272659e 100644 --- a/Detailed-Topics/Artifacts.md +++ b/Detailed-Topics/Artifacts.md @@ -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 . +The new location for this page is . + # Artifacts diff --git a/Detailed-Topics/Best-Practices.md b/Detailed-Topics/Best-Practices.md index 7f1d133..b14e127 100644 --- a/Detailed-Topics/Best-Practices.md +++ b/Detailed-Topics/Best-Practices.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Best Practices This page describes best practices for working with sbt. diff --git a/Detailed-Topics/Classpaths.md b/Detailed-Topics/Classpaths.md index 168d56f..b894413 100644 --- a/Detailed-Topics/Classpaths.md +++ b/Detailed-Topics/Classpaths.md @@ -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 . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Command-Line-Reference.md b/Detailed-Topics/Command-Line-Reference.md index cd7bf63..2051f62 100644 --- a/Detailed-Topics/Command-Line-Reference.md +++ b/Detailed-Topics/Command-Line-Reference.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Command Line Reference This page is a relatively complete list of command line options, diff --git a/Detailed-Topics/Compiler-Plugins.md b/Detailed-Topics/Compiler-Plugins.md index a792ddb..01025ed 100644 --- a/Detailed-Topics/Compiler-Plugins.md +++ b/Detailed-Topics/Compiler-Plugins.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Compiler Plugin Support There is some special support for using compiler plugins. You can set `auto-compiler-plugins` to `true` to enable this functionality. diff --git a/Detailed-Topics/Console-Project.md b/Detailed-Topics/Console-Project.md index 3e326ac..a9fffad 100644 --- a/Detailed-Topics/Console-Project.md +++ b/Detailed-Topics/Console-Project.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Console Project # Description diff --git a/Detailed-Topics/Cross-Build.md b/Detailed-Topics/Cross-Build.md index f0a3262..0b4ba48 100644 --- a/Detailed-Topics/Cross-Build.md +++ b/Detailed-Topics/Cross-Build.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Cross-building # Introduction diff --git a/Detailed-Topics/Detailed-Topics.md b/Detailed-Topics/Detailed-Topics.md index 5ee3a76..af9c693 100644 --- a/Detailed-Topics/Detailed-Topics.md +++ b/Detailed-Topics/Detailed-Topics.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Detailed Topic Pages This part of the wiki has pages documenting particular sbt topics. diff --git a/Detailed-Topics/Forking.md b/Detailed-Topics/Forking.md index f8648bb..b485a2e 100644 --- a/Detailed-Topics/Forking.md +++ b/Detailed-Topics/Forking.md @@ -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 . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Global-Settings.md b/Detailed-Topics/Global-Settings.md index 8d4bb53..f02ab3c 100644 --- a/Detailed-Topics/Global-Settings.md +++ b/Detailed-Topics/Global-Settings.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Global Settings ## Basic global configuration file diff --git a/Detailed-Topics/Inspecting-Settings.md b/Detailed-Topics/Inspecting-Settings.md index e1ab340..bde1585 100644 --- a/Detailed-Topics/Inspecting-Settings.md +++ b/Detailed-Topics/Inspecting-Settings.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Using the Configuration System Central to sbt is the new configuration system, which is designed to enable extensive customization. diff --git a/Detailed-Topics/Java-Sources.md b/Detailed-Topics/Java-Sources.md index 7fdbb16..b8e7d5b 100644 --- a/Detailed-Topics/Java-Sources.md +++ b/Detailed-Topics/Java-Sources.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Launcher.md b/Detailed-Topics/Launcher.md index a91f621..c47f9f8 100644 --- a/Detailed-Topics/Launcher.md +++ b/Detailed-Topics/Launcher.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Library-Management.md b/Detailed-Topics/Library-Management.md index ad34ff8..b68ee70 100644 --- a/Detailed-Topics/Library-Management.md +++ b/Detailed-Topics/Library-Management.md @@ -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 . +The new location for this page is . + # Library Management There's now a diff --git a/Detailed-Topics/Local-Scala.md b/Detailed-Topics/Local-Scala.md index ae902e5..47a97ae 100644 --- a/Detailed-Topics/Local-Scala.md +++ b/Detailed-Topics/Local-Scala.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Local Scala To use a locally built Scala version, define the `scala-home` setting, which is of type `Option[File]`. diff --git a/Detailed-Topics/Mapping-Files.md b/Detailed-Topics/Mapping-Files.md index a787788..1fdf550 100644 --- a/Detailed-Topics/Mapping-Files.md +++ b/Detailed-Topics/Mapping-Files.md @@ -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 . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Migrating-from-SBT-0.7.x-to-0.10.x.md b/Detailed-Topics/Migrating-from-SBT-0.7.x-to-0.10.x.md index c5e24dd..0839509 100644 --- a/Detailed-Topics/Migrating-from-SBT-0.7.x-to-0.10.x.md +++ b/Detailed-Topics/Migrating-from-SBT-0.7.x-to-0.10.x.md @@ -1,3 +1,10 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + +# 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. diff --git a/Detailed-Topics/Parallel-Execution.md b/Detailed-Topics/Parallel-Execution.md index 4c0901d..14a43df 100644 --- a/Detailed-Topics/Parallel-Execution.md +++ b/Detailed-Topics/Parallel-Execution.md @@ -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 . +The new location for this page is . + # Task ordering Task ordering is specified by declaring a task's inputs. diff --git a/Detailed-Topics/Parsing-Input.md b/Detailed-Topics/Parsing-Input.md index 141db00..f2f4d10 100644 --- a/Detailed-Topics/Parsing-Input.md +++ b/Detailed-Topics/Parsing-Input.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Parsing and tab completion This page describes the parser combinators in sbt. diff --git a/Detailed-Topics/Paths.md b/Detailed-Topics/Paths.md index 42a6cf4..15d0774 100644 --- a/Detailed-Topics/Paths.md +++ b/Detailed-Topics/Paths.md @@ -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 . +The new location for this page is . + # 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: diff --git a/Detailed-Topics/Process.md b/Detailed-Topics/Process.md index e021933..c518c5a 100644 --- a/Detailed-Topics/Process.md +++ b/Detailed-Topics/Process.md @@ -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 . +The new location for this page is . + # External Processes # Usage diff --git a/Detailed-Topics/Publishing.md b/Detailed-Topics/Publishing.md index 4b1aa28..a979872 100644 --- a/Detailed-Topics/Publishing.md +++ b/Detailed-Topics/Publishing.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Resolvers.md b/Detailed-Topics/Resolvers.md index c19d5c5..bd200bb 100644 --- a/Detailed-Topics/Resolvers.md +++ b/Detailed-Topics/Resolvers.md @@ -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 . +The new location for this page is . + # Resolvers ## Maven diff --git a/Detailed-Topics/Running-Project-Code.md b/Detailed-Topics/Running-Project-Code.md index 667c182..b6cd523 100644 --- a/Detailed-Topics/Running-Project-Code.md +++ b/Detailed-Topics/Running-Project-Code.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # 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]]. diff --git a/Detailed-Topics/Scripts.md b/Detailed-Topics/Scripts.md index 4e33f4f..6a69959 100644 --- a/Detailed-Topics/Scripts.md +++ b/Detailed-Topics/Scripts.md @@ -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 . +The new location for this page is . + # Scripts, REPL, and Dependencies sbt has two alternative entry points that may be used to: diff --git a/Detailed-Topics/Setup-Notes.md b/Detailed-Topics/Setup-Notes.md index c8eff42..411a77b 100644 --- a/Detailed-Topics/Setup-Notes.md +++ b/Detailed-Topics/Setup-Notes.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Setup Notes Some notes on how to set up your `sbt` script. diff --git a/Detailed-Topics/TaskInputs.md b/Detailed-Topics/TaskInputs.md index 40d61ba..985dc27 100644 --- a/Detailed-Topics/TaskInputs.md +++ b/Detailed-Topics/TaskInputs.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Task Inputs/Dependencies Tasks with dependencies are now introduced in the diff --git a/Detailed-Topics/Tasks.md b/Detailed-Topics/Tasks.md index af35a81..3613287 100644 --- a/Detailed-Topics/Tasks.md +++ b/Detailed-Topics/Tasks.md @@ -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 . +The new location for this page is . + # Tasks Tasks and settings are now introduced in the diff --git a/Detailed-Topics/Testing.md b/Detailed-Topics/Testing.md index a1d9b45..368c64b 100644 --- a/Detailed-Topics/Testing.md +++ b/Detailed-Topics/Testing.md @@ -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 . +The new location for this page is . + # Testing # Basics diff --git a/Detailed-Topics/Triggered-Execution.md b/Detailed-Topics/Triggered-Execution.md index 5d7eed5..5d8cd53 100644 --- a/Detailed-Topics/Triggered-Execution.md +++ b/Detailed-Topics/Triggered-Execution.md @@ -1,5 +1,10 @@ [web plugin]: https://github.com/siasia/xsbt-web-plugin +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # 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. diff --git a/Detailed-Topics/Update-Report.md b/Detailed-Topics/Update-Report.md index e6b3c9a..5124e20 100644 --- a/Detailed-Topics/Update-Report.md +++ b/Detailed-Topics/Update-Report.md @@ -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 . +The new location for this page is . + # Update Report `update` and related tasks produce a value of type [sbt.UpdateReport] diff --git a/Did-not-mean-to-delete-this....md b/Did-not-mean-to-delete-this....md deleted file mode 100644 index d08ea62..0000000 --- a/Did-not-mean-to-delete-this....md +++ /dev/null @@ -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. \ No newline at end of file diff --git a/Examples/Advanced-Command-Example.md b/Examples/Advanced-Command-Example.md index 7ba7c83..20ef27b 100644 --- a/Examples/Advanced-Command-Example.md +++ b/Examples/Advanced-Command-Example.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # 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. diff --git a/Examples/Advanced-Configurations-Example.md b/Examples/Advanced-Configurations-Example.md index 87d8ee8..c6dbfcd 100644 --- a/Examples/Advanced-Configurations-Example.md +++ b/Examples/Advanced-Configurations-Example.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + ## Advanced Configurations Example This is an example [[full build definition|Full Configuration]] that demonstrates using Ivy configurations to group dependencies. diff --git a/Examples/Examples.md b/Examples/Examples.md index 72ed8d2..7fc1b16 100644 --- a/Examples/Examples.md +++ b/Examples/Examples.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Examples This section of the wiki has example sbt build definitions and diff --git a/Examples/Full-Configuration-Example.md b/Examples/Full-Configuration-Example.md index 26444c5..99b6079 100644 --- a/Examples/Full-Configuration-Example.md +++ b/Examples/Full-Configuration-Example.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + ## 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. diff --git a/Examples/Quick-Configuration-Examples.md b/Examples/Quick-Configuration-Examples.md index fd9e2e7..0616309 100644 --- a/Examples/Quick-Configuration-Examples.md +++ b/Examples/Quick-Configuration-Examples.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + [sbt.SettingDefinition]: http://harrah.github.com/xsbt/latest/api/sbt/Init$SettingsDefinition.html Listed here are some examples of settings (each setting is diff --git a/Extending/Build-Loaders.md b/Extending/Build-Loaders.md index c781e7c..96e77fe 100644 --- a/Extending/Build-Loaders.md +++ b/Extending/Build-Loaders.md @@ -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 . +The new location for this page is . # Build Loaders diff --git a/Extending/Build-State.md b/Extending/Build-State.md index 3d912a3..241fc57 100644 --- a/Extending/Build-State.md +++ b/Extending/Build-State.md @@ -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 . +The new location for this page is . + # State and actions [State] is the entry point to all available information in sbt. diff --git a/Extending/Command-Line-Applications.md b/Extending/Command-Line-Applications.md index 374464a..dadb932 100644 --- a/Extending/Command-Line-Applications.md +++ b/Extending/Command-Line-Applications.md @@ -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 . +The new location for this page is . + # Creating Command Line Applications Using sbt There are several components of sbt that may be used to create a command line application. diff --git a/Extending/Commands.md b/Extending/Commands.md index 752a956..4d078d5 100644 --- a/Extending/Commands.md +++ b/Extending/Commands.md @@ -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 . +The new location for this page is . + # Commands # What is a "command"? diff --git a/Extending/Extending.md b/Extending/Extending.md index a7e8671..b1ec08a 100644 --- a/Extending/Extending.md +++ b/Extending/Extending.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Extending sbt This part of the wiki has pages documenting sbt "internals," diff --git a/Extending/Input-Tasks.md b/Extending/Input-Tasks.md index 6a9642e..a0ff88f 100644 --- a/Extending/Input-Tasks.md +++ b/Extending/Input-Tasks.md @@ -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 . +The new location for this page is . + # 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. diff --git a/Extending/Plugins-Best-Practices.md b/Extending/Plugins-Best-Practices.md index 7f277d9..abca420 100644 --- a/Extending/Plugins-Best-Practices.md +++ b/Extending/Plugins-Best-Practices.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Plugins Best Practices _This page is intended primarily for SBT plugin authors._ diff --git a/Extending/Plugins.md b/Extending/Plugins.md index 86d17a3..eedef09 100644 --- a/Extending/Plugins.md +++ b/Extending/Plugins.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Plugins # Introduction diff --git a/Extending/Settings-Core.md b/Extending/Settings-Core.md index 12520be..feb3840 100644 --- a/Extending/Settings-Core.md +++ b/Extending/Settings-Core.md @@ -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 . +The new location for this page is . + # 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. diff --git a/FAQ.md b/FAQ.md index 8dfb13f..e19a337 100644 --- a/FAQ.md +++ b/FAQ.md @@ -26,6 +26,11 @@ # Frequently Asked Questions +## Docucmentation has moved + +The documentation for sbt has moved to . +The new location for the FAQ is . + ## Project Information ### How do I get help? diff --git a/Getting-Started/Getting-Started-Basic-Def.md b/Getting-Started/Getting-Started-Basic-Def.md index aa8ff3e..87930e8 100644 --- a/Getting-Started/Getting-Started-Basic-Def.md +++ b/Getting-Started/Getting-Started-Basic-Def.md @@ -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 . +The new location for this page is . + # `.sbt` Build Definition [[Previous|Getting Started Running]] _Getting Started Guide page 6 of 14._ [[Next|Getting Started Scopes]] diff --git a/Getting-Started/Getting-Started-Custom-Settings.md b/Getting-Started/Getting-Started-Custom-Settings.md index ce54021..bb80218 100644 --- a/Getting-Started/Getting-Started-Custom-Settings.md +++ b/Getting-Started/Getting-Started-Custom-Settings.md @@ -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 . +The new location for this page is . + # Custom Settings and Tasks [[Previous|Getting Started Multi-Project]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Directories.md b/Getting-Started/Getting-Started-Directories.md index 1b74801..eb9d2d5 100644 --- a/Getting-Started/Getting-Started-Directories.md +++ b/Getting-Started/Getting-Started-Directories.md @@ -1,5 +1,10 @@ [Maven]: http://maven.apache.org/ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Directory structure [[Previous|Getting Started Hello]] _Getting Started Guide page 4 of 14._ [[Next|Getting Started Running]] diff --git a/Getting-Started/Getting-Started-Full-Def.md b/Getting-Started/Getting-Started-Full-Def.md index 61ef958..25627a6 100644 --- a/Getting-Started/Getting-Started-Full-Def.md +++ b/Getting-Started/Getting-Started-Full-Def.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # `.scala` Build Definition [[Previous|Getting Started Library Dependencies]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Hello.md b/Getting-Started/Getting-Started-Hello.md index fab159c..6b68d0a 100644 --- a/Getting-Started/Getting-Started-Hello.md +++ b/Getting-Started/Getting-Started-Hello.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Hello, World [[Previous|Getting Started Setup]] _Getting Started Guide page 3 of 14._ [[Next|Getting Started Directories]] diff --git a/Getting-Started/Getting-Started-Library-Dependencies.md b/Getting-Started/Getting-Started-Library-Dependencies.md index b46002e..0722881 100644 --- a/Getting-Started/Getting-Started-Library-Dependencies.md +++ b/Getting-Started/Getting-Started-Library-Dependencies.md @@ -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 . +The new location for this page is . + # Library Dependencies [[Previous|Getting Started More About Settings]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-More-About-Settings.md b/Getting-Started/Getting-Started-More-About-Settings.md index 7d8a72d..ef5e536 100644 --- a/Getting-Started/Getting-Started-More-About-Settings.md +++ b/Getting-Started/Getting-Started-More-About-Settings.md @@ -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 . +The new location for this page is . + # More Kinds of Setting [[Previous|Getting Started Scopes]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Multi-Project.md b/Getting-Started/Getting-Started-Multi-Project.md index a26209e..fdd2e4d 100644 --- a/Getting-Started/Getting-Started-Multi-Project.md +++ b/Getting-Started/Getting-Started-Multi-Project.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Multi-Project Builds [[Previous|Getting Started Using Plugins]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Running.md b/Getting-Started/Getting-Started-Running.md index 063d7ff..824d965 100644 --- a/Getting-Started/Getting-Started-Running.md +++ b/Getting-Started/Getting-Started-Running.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Running [[Previous|Getting Started Directories]] _Getting Started Guide page 5 of 14._ [[Next|Getting Started Basic Def]] diff --git a/Getting-Started/Getting-Started-Scopes.md b/Getting-Started/Getting-Started-Scopes.md index 401ffd6..7d3784a 100644 --- a/Getting-Started/Getting-Started-Scopes.md +++ b/Getting-Started/Getting-Started-Scopes.md @@ -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 . +The new location for this page is . + # Scopes [[Previous|Getting Started Basic Def]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Setup.md b/Getting-Started/Getting-Started-Setup.md index ebd4b18..0968f37 100644 --- a/Getting-Started/Getting-Started-Setup.md +++ b/Getting-Started/Getting-Started-Setup.md @@ -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 . +The new location for this page is . + # Setup [[Previous|Getting Started Welcome]] _Getting Started Guide page 2 of 14._ [[Next|Getting Started Hello]] diff --git a/Getting-Started/Getting-Started-Summary.md b/Getting-Started/Getting-Started-Summary.md index e838b22..f4eceae 100644 --- a/Getting-Started/Getting-Started-Summary.md +++ b/Getting-Started/Getting-Started-Summary.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Getting Started Summary [[Previous|Getting Started Custom Settings]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Using-Plugins.md b/Getting-Started/Getting-Started-Using-Plugins.md index b0986f5..8eead23 100644 --- a/Getting-Started/Getting-Started-Using-Plugins.md +++ b/Getting-Started/Getting-Started-Using-Plugins.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Using Plugins [[Previous|Getting Started Full Def]] _Getting Started Guide page diff --git a/Getting-Started/Getting-Started-Welcome.md b/Getting-Started/Getting-Started-Welcome.md index ebae0d8..cce1e50 100644 --- a/Getting-Started/Getting-Started-Welcome.md +++ b/Getting-Started/Getting-Started-Welcome.md @@ -1,3 +1,8 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + # Welcome! _Getting Started Guide page 1 of 14._ [[Next|Getting Started Setup]] diff --git a/Home.md b/Home.md index 17d7973..19e26f5 100644 --- a/Home.md +++ b/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 . 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 . diff --git a/Index.md b/Index.md index ed6f94a..9230113 100644 --- a/Index.md +++ b/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 . +The new location for this page is . + # Index This is an index of common methods, types, and values you might find in an sbt build definition. diff --git a/Resources.md b/Resources.md index f19681f..3c3461d 100644 --- a/Resources.md +++ b/Resources.md @@ -1,3 +1,9 @@ +# Documentation has moved + +The documentation for sbt has moved to . + +## 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=) diff --git a/Setup.md b/Setup.md deleted file mode 100644 index ef54628..0000000 --- a/Setup.md +++ /dev/null @@ -1 +0,0 @@ -ttt \ No newline at end of file diff --git a/Understanding-incremental-recompilation.md b/Understanding-incremental-recompilation.md index 1b0c8a8..7fee8d3 100644 --- a/Understanding-incremental-recompilation.md +++ b/Understanding-incremental-recompilation.md @@ -1,3 +1,10 @@ +# Documentation has moved + +The documentation for sbt has moved to . +The new location for this page is . + +## 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.