Doco updates.
This commit is contained in:
parent
8b61bd61e3
commit
dfb4b759b0
9 changed files with 26 additions and 14 deletions
10
NEWS
10
NEWS
|
@ -2,6 +2,16 @@ Leiningen NEWS -- history of user-visible changes
|
|||
|
||||
= 1.6.0 / ???
|
||||
|
||||
* Enforce project names as readable symbols.
|
||||
|
||||
* Add trampoline task.
|
||||
|
||||
* Fix a bug where plugins would be unavailable in MinGW.
|
||||
|
||||
* Allow functions other than -main to be called using run task.
|
||||
|
||||
* Support constructing classpath out of ~/.m2 instead of copying to lib/.
|
||||
|
||||
* Fix a bug where help output could be truncated by plugin issues.
|
||||
|
||||
* Support native dependencies.
|
||||
|
|
|
@ -209,9 +209,9 @@ See the plugin task's help for more information.
|
|||
new processes that blocks access to console input. This means that
|
||||
functions like <tt>read-line</tt> will not work as expected in most
|
||||
contexts, though the <tt>repl</tt> task necessarily includes a
|
||||
workaround. You can also use <tt>java -cp \`lein classpath\`
|
||||
my.main.namespace</tt> to launch a process with the correct
|
||||
classpath that still has access to stdin.
|
||||
workaround. You can also use the <tt>trampoline</tt> task to
|
||||
launch your project's JVM after Leiningen's has exited rather than
|
||||
launching it as a subprocess
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@
|
|||
(make-repository [repository-name repository])))
|
||||
|
||||
(defn deploy
|
||||
"Build and deploy jar to remote repository.
|
||||
"Build jar and deploy to remote repository.
|
||||
|
||||
The target repository will be looked up in :repositories: snapshot
|
||||
versions will go to the repo named \"snapshots\" while stable versions
|
||||
|
|
|
@ -88,7 +88,7 @@
|
|||
Also provides readme, tutorial, news, sample, and copying documentation."
|
||||
([task] (println (or (static-help task) (help-for task))))
|
||||
([]
|
||||
(println "Leiningen is a build tool for Clojure.\n")
|
||||
(println "Leiningen is a tool for working with Clojure projects.\n")
|
||||
(println "Several tasks are available:")
|
||||
(doseq [task-ns tasks]
|
||||
(println (help-summary-for task-ns)))
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
nil nil `(require '~main-ns)))))
|
||||
|
||||
(defn ^{:help-arglists '([])} run
|
||||
"Run a -main function with optional command-line arguments.
|
||||
"Run the project's -main function.
|
||||
|
||||
USAGE: lein run [--] [ARGS...]
|
||||
Calls the -main function in the namespace specified as :main in project.clj.
|
||||
|
|
|
@ -76,7 +76,7 @@
|
|||
(prn)))
|
||||
|
||||
(defn ^{:help-arglists '([query] [query page])} search
|
||||
"Search remote repository contents.
|
||||
"Search remote repositories.
|
||||
|
||||
The first run will download a set of indices, which will take a
|
||||
while. Pass in --update as the query to force a fresh download of all
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
(ns leiningen.test!
|
||||
"Run a project's tests after cleaning and fetching dependencies."
|
||||
"Run the project's tests after cleaning and fetching dependencies."
|
||||
(:refer-clojure :exclude [test])
|
||||
(:use [leiningen.clean :only [clean]]
|
||||
[leiningen.deps :only [deps]]
|
||||
|
|
|
@ -18,14 +18,16 @@
|
|||
(spit (System/getProperty "leiningen.trampoline-file") command))
|
||||
|
||||
(defn trampoline
|
||||
"Calculate what needs to run in the project's process for the
|
||||
provided task and run it after Leiningen's own process has exited
|
||||
rather than as a subprocess of Leiningen's project.
|
||||
"Run a task without nesting the project's JVM inside Leiningen's.
|
||||
|
||||
ALPHA: subject to change without warning.
|
||||
Calculates what needs to run in the project's process for the provided
|
||||
task and runs it after Leiningen's own JVM process has exited rather
|
||||
than as a subprocess of Leiningen's project.
|
||||
|
||||
Use this to save memory or to work around things like Ant's stdin
|
||||
issues. Not compatible with chaining."
|
||||
issues. Not compatible with chaining.
|
||||
|
||||
ALPHA: subject to change without warning."
|
||||
[project task-name & args]
|
||||
(let [java-cmd (format "%s/bin/java" (System/getProperty "java.home"))
|
||||
jvm-opts (get-input-args)
|
||||
|
|
|
@ -66,7 +66,7 @@
|
|||
(.closeEntry out))))
|
||||
|
||||
(defn uberjar
|
||||
"Package up the project files and deps into a jar file.
|
||||
"Package up the project files and all dependencies into a jar file.
|
||||
|
||||
Includes the contents of each of the dependency jars. Suitable for standalone
|
||||
distribution."
|
||||
|
|
Loading…
Reference in a new issue