Commit graph

317 commits

Author SHA1 Message Date
Phil Hagelberg
e13312d344 Merge remote-tracking branch 'hugoduncan/feature/add-project-profile' into profiles-from-plugins 2014-09-05 19:29:35 -07:00
Phil Hagelberg
e9c9ff4883 Document in-plugin profiles. 2014-09-04 19:25:58 -07:00
Hugo Duncan
a83aefe6cc Expand builtin profile docs in README 2014-09-04 15:20:08 -04:00
Hugo Duncan
5b4cda662a Add :project profile to PROFILES.md 2014-09-04 08:43:50 -04:00
Jean Niklas L'orange
b9dced16d5 Clarify what "last one" means for profile override
Re: #1646
[ci-skip]
2014-08-17 23:43:14 +02:00
Phil Hagelberg
9750d8e4b2 Document using unquote in :dev profile for OS-specific config.
Addresses #1228.
2014-08-09 11:41:23 -07:00
Phil Hagelberg
798873d467 Merge pull request #1611 from techwhizbang/master
read-eval example provided in PROFILES.md
2014-07-24 13:25:04 -07:00
Nick Zalabak
60e4ef856c read-eval example provided in PROFILES.md 2014-07-24 12:24:30 -07:00
Jean Niklas L'orange
fba7f8ccba Don't wrap :signing in a map in the docs.
Fixes #1594. [ci-skip]
2014-07-11 11:25:08 +02:00
Christopher Bui
b8894047e4 Remove inline code blocks 2014-06-27 17:44:12 -05:00
Christopher Bui
d20d78cba2 Remove citations and change 'voice'
Solutions via people from this issue: https://github.com/technomancy/leiningen/issues/615
2014-06-27 17:43:08 -05:00
Christopher Bui
f55c45797a Document some common issues with GPG on Mac OSX
Deals with this issue: https://github.com/technomancy/leiningen/issues/1386
2014-06-20 21:06:31 -05:00
Phil Hagelberg
a7415d2dbe Document pom.properties.
[ci skip]
2014-06-13 16:23:38 -07:00
Phil Hagelberg
4e5c9112f4 Document how to use bundled clojars.pem in case of CA problems.
Refs #1053.
2014-06-13 15:57:19 -07:00
Phil Hagelberg
46f1556111 Document partial alias splicing.
[ci skip]
2014-06-08 15:21:05 -07:00
Phil Hagelberg
ff106cb7b7 Remove repo aliasing from deploy task; already done elsewhere.
Also clean up some formatting in deploy guide.

Fixes #1548
2014-06-06 18:14:43 -07:00
Phil Hagelberg
353d73912c Allow for plugins to override built-in tasks. 2014-06-05 12:08:06 -07:00
Stuart Hinson
ba276eea4f remove unnecessary quote escaping in composite profile example 2014-06-01 13:00:10 -04:00
Phil Hagelberg
a58a51abf0 Document use of the SSH wagon. Fixes #1540. 2014-05-28 22:03:47 -07:00
Phil Hagelberg
d8634b2272 Pass a stringed symbol into bump-version instead of a keyword. 2014-05-27 16:37:59 -07:00
Phil Hagelberg
547f4a7b9c Formatting fix.
[ci skip]
2014-05-27 15:53:23 -07:00
Phil Hagelberg
b3f3537386 Avoid need for double-escaping in :release-tasks.
As per the recommendation of @crisptrutski.
2014-05-27 15:05:00 -07:00
Phil Hagelberg
fd615c1d44 Technically :alpha, :beta, and :rc aren't semantic levels.
[ci skip]
2014-05-27 14:33:23 -07:00
Phil Hagelberg
ecdccda9eb Support :alpha, :beta, and :rc bump levels. 2014-05-27 13:37:22 -07:00
Phil Hagelberg
b1a07d03ec Pass arguments to f in change task through the reader.
This means that you can use non-strings as args in the change task,
but it requires double-quoting when you do want strings.
2014-05-27 11:46:15 -07:00
Phil Hagelberg
dd7447544b Encourage use of main/info and friends for plugin output. 2014-05-27 11:24:13 -07:00
Phil Hagelberg
88f2d3458e Reword a few things in deploy.md. 2014-05-27 10:46:37 -07:00
Phil Hagelberg
3e6b8a1818 Merge remote-tracking branch 'waynr/deploy-repositories-aliasing'
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
2014-05-27 10:38:02 -07:00
Wayne
07c1c7a7f8 Enable simple aliasing in :deploy-repositories. 2014-05-26 19:00:35 -07:00
Wayne
9b652d703a Document the release task.
Also adds sample alternate release workflow in sample.project.clj.
2014-05-26 15:38:04 -07:00
Phil Hagelberg
ec45757459 Automatically load methods for other leiningen.vcs systems. 2014-05-23 20:59:34 -07:00
Antoine R. Dumont
7b151b262d Add TOC to the tutorial 2014-05-23 19:25:19 +02:00
Phil Hagelberg
4db84a0423 Merge pull request #1513 from cmpitg/better-documentation
Add structure of the newly created sample template
2014-04-24 13:43:41 -07:00
Nguyễn Hà Dương
e6abef4b0e Add structure of the newly created sample template
I think it might be better to provide a quick look at the new template structure before going to any detail?
2014-04-24 15:28:16 +07:00
Jakub Holy
0d7932f994 PROFILES.md: Tip to use composite profile
Sometimes we need to override *parts* of a prticular profile on a project-specific base. To a novice
lein user, it is likely not clear how to achieve this. This tip points her in the right direction -
using a composite profile with a "personal" part that can be overriden in `profiles.clj` to change
what is in the "common" part of the profile.
2014-04-24 08:27:15 +02:00
Jakub Holy
3fe00b2578 Update PROFILES.md 2014-04-23 13:27:04 +02:00
Jakub Holy
5abe5718bc PROFILES.md - be really explicit about overriding
While "Declaring Profiles" states that "Profiles specified in `profiles.clj` will override
profiles in `project.clj`," some less attentive reader can interpret it so that *keys/values* from profiles.clj override those from project.clj, not that the profile as whole is replaced. This changes
tries to make it really clear. (Of course feel free to change the wording as you see fit.)
2014-04-23 10:28:30 +02:00
Phil Hagelberg
4349878d7c Remove mention of :omit-default-repositories.
Fixes #1472.
2014-04-22 17:01:01 -07:00
Phil Hagelberg
fed957c72f Clarify a few points of documentation. Fixes #1475.
[ci skip]
2014-04-22 14:44:46 -07:00
Toby Crawley
0644eab9c4 Document various ways to register wagon factories [fixes #1483] 2014-04-07 09:58:25 -04:00
Eunmin
12e4b460ad Correcting errors that used to be :sources-paths in plugin document. 2014-04-02 19:54:32 +09:00
Phil Hagelberg
f509d4ec3d Document :pass-through-help in plugin guide. 2014-03-07 10:23:19 -08:00
Jean Niklas L'orange
f2008d38ca Merge pull request #1431 from hura/patch-1
Update TUTORIAL.md
2014-01-28 18:57:23 +01:00
hura
83a120d70e Update TUTORIAL.md
AOT abbreviations is now explained
2014-01-28 12:35:40 -05:00
Matt Blair
b35aa83874 mention all files created by the project generator 2014-01-27 13:17:38 -08:00
MerelyAPseudonym
b366c85b56 Fix "singing"/"signing" typo. 2014-01-22 16:39:13 -05:00
Phil Hagelberg
ff403992e4 Update plugin guide. 2014-01-20 10:49:21 -08:00
Laurent Petit
672d204ddb Add nREPL URL to output along side the human readable message 2014-01-09 22:41:34 +01:00
Jean Niklas L'orange
b497494b04 Merge pull request #1408 from drewnoakes/docs/tutorial
Updated TUTORIAL.md for Leiningen 2.3.4

[ci skip]
2014-01-07 10:58:36 -08:00
Drew Noakes
9291140e2e Updated TUTORIAL.md for Leiningen 2.3.4.
Updated `project.clj` file output created by `lein new app`.

Updated references to clojure 1.4.0 with clojure 1.5.1 (current stable release.)

Updated banner text displayed by `lein repl`.

Updated output of unit tests.

Updated command required to run a single unit test as the name is different in the current `app` template.
2014-01-07 18:53:16 +00:00
Aaron Brooks
f5bea91dda Make "/etc/leiningen" profile inclusion clearer. 2013-12-04 15:54:41 -05:00
Phil Hagelberg
7664d18915 Update man page. 2013-11-19 21:03:11 -08:00
Sebastian Sogamoso
928fd88542 Minor TUTORIAL fix 2013-11-15 17:58:40 -05:00
Phil Hagelberg
088a05f66f Reformat FAQ.md's markdown to be a little more shell-friendly. 2013-11-14 12:06:51 -08:00
Jean Niklas L'orange
c6d937b377 Clarify order-dependent conflict resolutions.
Closes #1337. [ci skip]
2013-11-14 12:06:51 -08:00
Phil Hagelberg
9718597bd4 Update sample.project.clj and NEWS.md. 2013-11-14 11:02:06 -08:00
Patrick Shields
81562aefc4 Update dependency name in profile example
It looks like in cab18f6bfe the dependency changed from midje to expectations, but the explanation text still referred to midje.
2013-10-30 14:38:05 -04:00
Jean Niklas L'orange
e9d366c38b Merge pull request #1351 from coventry/more-explicit-instructions-on-installing-dependencies
Mention `lein deps` in the tutorial.
2013-10-18 01:18:48 -07:00
Alex Coventry
3e1d5fbe51 Mention lein deps in the tutorial.
Describe how to use lein to actually install and use a dependency.
2013-10-17 23:58:48 -04:00
John Conti
40caa932fe Fix typo in lein template invocation command. 2013-09-21 07:08:35 -06:00
Phil Hagelberg
d37195b877 Fix tutorial repl message. Addresses #1317. 2013-09-19 10:39:30 -07:00
Alex Coventry
aa320f5bc5 lein install may not be needed if lein can find the library in another
repository.
2013-08-28 15:15:38 -04:00
Alex Coventry
cd915ebdaf Slight clarification to checkout dependency usage 2013-08-28 13:20:11 -04:00
Phil Hagelberg
1d5f1a0709 Explain profile isolation in FAQ.
[ci skip]
2013-08-20 12:28:28 -07:00
Phil Hagelberg
ad48331f26 Encourage production use of uberjars over lein run in tutorial. 2013-08-20 11:57:49 -07:00
Phil Hagelberg
bb5dc78c35 Discuss idempotency of hooks/middleware in plugin docs. 2013-08-20 11:57:27 -07:00
Phil Hagelberg
3647c799c4 Mention setting :sign-releases false during deploy. 2013-08-20 11:56:14 -07:00
Phil Hagelberg
4b099af5d1 Improve coverage of profiles in tutorial and profiles doc. 2013-08-12 17:15:40 -07:00
Phil Hagelberg
7e7a38e332 Suggest using profiles to change project map in PLUGINS.md.
Also clarify that auto-loaded hooks are only checked in :plugins.

Fixes #1258.
2013-07-31 22:02:16 -07:00
Jean Niklas L'orange
ea90ec0145 Properly document template tags. 2013-07-29 01:06:31 +02:00
Phil Hagelberg
9a5ce6ac6b News updates. 2013-07-28 12:51:38 -07:00
Phil Hagelberg
cab18f6bfe Mention +/- syntax and per-profile isolation in PROFILES.md. 2013-07-26 14:11:43 -07:00
Gabriel Horner
7b03f8733c fix typos in docs 2013-07-01 07:26:30 -04:00
Jean Niklas L'orange
0f861c8349 Fix garbled sentence and broken formatting. 2013-06-26 13:56:16 +02:00
Jean Niklas L'orange
29d3776f28 Add FAQ entry on background procs. Closes #1173. 2013-06-26 13:53:28 +02:00
Jason Wolfe
8eca6a1c08 Update FAQ to add entry about long-term performance 2013-06-20 00:12:35 -07:00
Phil Hagelberg
f92ca69c8b gpg-agent caching is time-bounded. 2013-06-12 17:05:12 -07:00
Zach Pendleton
6f24bd12ac add documentation on lein search options to tutorial. 2013-06-06 16:40:12 -06:00
Phil Hagelberg
577ef23d55 FAQ update.
[ci skip]
2013-05-29 20:38:50 -07:00
Toby Crawley
39b03b9457 Fix markdown render issue in GPG.md. 2013-05-23 16:16:19 -04:00
Alan Malloy
481def11dc Update GPG.md 2013-05-17 19:04:27 -07:00
Phil Hagelberg
0ddd6ca629 Deploy ad-hoc files. 2013-05-12 14:11:24 -07:00
bendlas
deba9c59ae Rename hooks to activate in hooks code sample
I'm not sure, if `hooks` was there on purpose, but if it was, it would need additional explainations.
2013-04-15 17:16:34 +03:00
Jean Niklas L'orange
66a6e2b2ef Update docs with semantic change for profiles.d
Ref fa602e807b.
2013-03-30 04:15:52 +01:00
Phil Hagelberg
a42c5521f4 Move Tiered Compilation to LEIN_JVM_OPTS and document.
Fixes #1111.
2013-03-28 11:04:13 -07:00
Toby Crawley
86e6cd88b4 GPG doc updates.
This includes:

* publishing to a keyserver
* revocation
* setting the default signing key via lein
2013-03-28 13:25:31 -04:00
Toby Crawley
437cf551f6 Move gpg setup notes from DEPLOY to GPG [fixes #1073] 2013-03-18 12:51:56 -07:00
Toby Crawley
ee2f4bed45 Add GPG doc. 2013-03-17 17:08:50 -07:00
Phil Hagelberg
2340166b2f Document non-traditional javac compilation order. (from Quoll) Fixes #847. 2013-03-09 17:21:26 -08:00
Michael Klishin
6c6d9e844e Move (:root project) docs next to the section on :no-project-needed 2013-03-01 23:30:52 +04:00
Michael Klishin
fd6af1af58 Document (:root project) 2013-03-01 23:29:22 +04:00
Sergey Vinokurov
efc580dd79 Fix some typos 2013-02-21 22:03:56 +02:00
Phil Hagelberg
5ff555db12 Tweak tutorial. 2013-02-21 10:38:21 -08:00
Phil Hagelberg
972bf935cc Fix FAQ formatting; link to "Faster" wiki page.
Note that the two spaces after each Q line are intentional; otherwise
we don't get proper line breaks.

[ci skip]
2013-02-21 10:18:54 -08:00
Trevor Wennblom
8aed31b3e6 update links to docs rc->stable 2013-02-11 19:19:20 -06:00
Gabriel Horner
cd3338fcaa update tutorial to correctly reference app template
closes #959
2013-01-31 00:57:44 -05:00
Jean Niklas L'orange
273544db08 Document profiles.d functionality. 2013-01-23 19:53:28 +01:00
Michael Klishin
0ef01ba38b a typo 2013-01-23 16:54:21 +04:00
Phil Hagelberg
f1b42bbde9 Remove swank from examples in profiles doc. Fixes #947.
[ci skip]
2013-01-21 20:41:19 -08:00
MerelyAPseudonym
f5492b9c2c Update URL to Tim Pope's "vim-foreplay"
Apparently he renamed the project at some point.
2013-01-21 09:44:52 -05:00
Phil Hagelberg
3b539495a4 Remove mention of preview from docs; use stable branch. 2013-01-19 20:39:43 -08:00
Phil Hagelberg
01e6c953c3 News and FAQ about implicit repl deps.
[ci skip]
2013-01-19 15:25:45 -08:00
Phil Hagelberg
9b91dc9dad Add a faq entry about implicit repl deps. 2013-01-18 17:18:31 -08:00
Phil Hagelberg
2e852fb563 Doc rewording for checkout deps. 2013-01-18 17:18:04 -08:00
Phil Hagelberg
6e42ceea19 Clarify wording of checkout dependencies in tutorial. 2013-01-17 11:47:25 -08:00
Phil Hagelberg
03151e1af9 Docs for new. 2013-01-11 11:04:26 -08:00
Phil Hagelberg
adab79df77 Todos and news. 2013-01-10 11:35:18 -08:00
Michael Hanson
f1b7365556 Use find . instead of tree in the tutorial
`find` is more universal than `tree`.

Fixes #892.
2013-01-09 20:07:58 -08:00
Trevor Wennblom
496f1352a1 No tabs
:)
2013-01-08 09:57:56 -06:00
Phil Hagelberg
0d69412db6 Move contributing guidelines into their own file. 2013-01-02 22:32:07 -08:00
François Bernier
296653e8f6 Fix deploy link in tutorial 2012-12-27 20:45:31 -05:00
Phil Hagelberg
83d23e3a18 FAQ clarification around classpathy things and repos. 2012-12-14 14:45:30 -08:00
Kevin Griffin
e457fc901e Update doc/TUTORIAL.md 2012-12-07 08:55:20 -05:00
Phil Hagelberg
f0b20c6201 Merge pull request #868 from hugoduncan/feature/add-profile
Add add-profile task, which adds profiles to the default
2012-11-26 12:00:58 -08:00
Hugo Duncan
3f08092d02 Update with-profile to accept +/- prefixes
Allow the profiles to be used to be specified as a delta from the default
profile list.
2012-11-26 14:54:08 -05:00
John Gabriele
9ec66a8b56 clarify maven repository terminology. Also,
added an oxford comma or two for good measure. :)
2012-11-26 12:17:41 -05:00
Phil Hagelberg
d4d6548dd3 Fix link in DEPLOY.md to use preview branch. Fixes #862. 2012-11-25 09:11:49 -08:00
Ben Mabey
4814b4adbb fixes code fence in plugin tutorial markdown 2012-11-19 11:36:45 -07:00
Phil Hagelberg
2973d99652 Check Clojars releases repository instead of classic. Fixes #241. 2012-11-14 12:45:34 -08:00
Phil Hagelberg
a418818a0a Typo in profiles doc; resource is actually singular.
[ci skip]
2012-10-23 15:56:07 -07:00
Colin Jones
0e8a8b9e18 Fix profiles doc example
fixes #825
2012-10-23 14:16:43 -05:00
Phil Hagelberg
ecdc783f2d repl task needs to disable pumping *in*. 2012-10-23 10:44:43 -07:00
Phil Hagelberg
eab8276a96 Clarify that project-level tasks are usually unnecessary. 2012-10-23 08:22:13 -07:00
John Gabriele
fafcdb7f47 remove mention of github as typ values for :url 2012-10-15 15:09:20 -03:00
John Gabriele
15c8850006 changed to keep preferred tag-line 2012-10-15 15:05:19 -03:00
John Gabriele
ad1f92555c doc/tut: various minor updates
Some wording tweaks at the top, formatting and addition to the list of things lein does.
2012-10-15 14:48:08 -03:00
Phil Hagelberg
94c2c15a84 The name of the directory is irrelevant in checkouts. 2012-10-10 11:28:30 -07:00
Michael S. Klishin
590a4e1b51 A typo 2012-10-10 22:16:25 +04:00
Michael S. Klishin
12856b5c19 Move checkout deps documentation to the tutorial, expand it with examples, change wording 2012-10-10 22:16:16 +04:00
Phil Hagelberg
329b4b7fa6 Un-deprecate :auth profile since full-disk encryption is a good use case for it. 2012-10-10 10:04:30 -07:00
Phil Hagelberg
bf50b253ec Mention other languages in mixed-projects. 2012-10-10 09:28:24 -07:00
Phil Hagelberg
67bbd4b97b There's nothing wrong with re-using :source-paths for java. 2012-10-10 09:26:44 -07:00
Michael S. Klishin
cf4c049970 New documentation guide: mixed Clojure/Java projects 2012-10-10 04:33:16 +04:00
Michael S. Klishin
c5de124677 Minor tutorial improvements 2012-10-07 02:16:40 +04:00
Tobias Crawley
6998dd6929 Support subtask specific help via 'lein help task subtask'
The help task will first look for static help under
'leiningen/help/task-subtask', then for a function name 'help-subtask' in the
subtask's namespace, then a docstring on the subtask function. For the latter
two options, the arglists are also printed.
2012-10-05 14:37:58 -04:00
Chas Emerick
102dcadf9f docs update for changes to resolution of repository credentials (gh-768) 2012-10-05 06:26:50 -04:00
Phil Hagelberg
72e6908778 Add a warning under project-specific tasks. 2012-09-11 10:43:28 -07:00
Charles Parker
11e6864e1b Plugin -> Task 2012-09-07 10:56:33 -07:00
Charles Parker
cee3d972e3 Little addition to plugins doc 2012-09-07 09:53:01 -07:00
Phil Hagelberg
b2a50ffe97 Clarify usage of .lein-classpath during plugin development. Fixes #750. 2012-08-28 11:22:11 -07:00
Marshall T. Vandegrift
be6f571104 Document :provided profile. 2012-08-24 08:34:22 -04:00
Phil Hagelberg
b5a193d331 Switch :repositories to vector format to preserve ordering.
See http://librelist.com/browser/leiningen/2012/8/17/ordering-issues-with-repositories/
for motivation.
2012-08-23 14:34:58 -07:00
Justin Balthrop
ff5524bdf1 support disabling autoload of plugin hooks and middleware 2012-08-23 13:29:37 -07:00
Justin Balthrop
69d3f80150 documentation for automatic plugin hooks and middleware 2012-08-22 15:35:21 -07:00
Phil Hagelberg
65a574d09a Document LEIN_FAST_TRAMPOLINE. 2012-08-17 14:32:29 -07:00
Phil Hagelberg
d9eba790de News updates. 2012-08-16 10:57:06 -07:00
Phil Hagelberg
b84da7b214 Mention :offline? and :local-repo for production deploys in tutorial. 2012-08-16 10:41:12 -07:00
Chas Emerick
8e0fe8e108 add recipe for Maven Central deployment to DEPLOY.md 2012-08-16 07:33:01 -04:00
Phil Hagelberg
50e14e06e6 Document gpg key generation in deployment guide. Fixes #721. 2012-08-10 18:55:15 -07:00
Phil Hagelberg
23d791d249 Document prep-tasks, :keyword task arg conventions, and l.c.m/abort. 2012-08-06 16:09:39 -07:00