Commit Graph

39 Commits

Author SHA1 Message Date
Etienne Millon e7fe7c3114 Document --watch flag
Signed-off-by: Etienne Millon <me@emillon.org>
2018-09-07 09:46:02 +02:00
Rudi Grinberg 5094d58774 Fix opam build instructions in usage.rst
They should include dune subst when pinning as well

Signed-off-by: Rudi Grinberg <rudi.grinberg@gmail.com>
2018-07-31 21:00:08 +02:00
Rudi Grinberg ad0b376aeb
Merge pull request #1064 from rgrinberg/jsoo-manual
Move Jsoo content to its own page
2018-07-30 19:03:07 +02:00
Rudi Grinberg 2836a3c6b0 Document the workspace level env stanza
Signed-off-by: Rudi Grinberg <rudi.grinberg@gmail.com>
2018-07-30 15:12:17 +02:00
Rudi Grinberg 3615b280f8 Move Jsoo content to its own page
Jsoo is about as independent as other features which have their own section

Signed-off-by: Rudi Grinberg <rudi.grinberg@gmail.com>
2018-07-30 11:47:35 +02:00
Etienne Millon 1d594ce5a3 Fix typos in source code
Signed-off-by: Etienne Millon <etienne@cryptosense.com>
2018-07-10 13:05:58 +01:00
Jérémie Dimino 3348b6a913
Adapt the behavior of dune subst for dune projects (#960)
Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2018-07-08 09:51:16 +01:00
Rudi Grinberg 0f607c39fb
More Manual Updates (#955)
This migrates the rest of the manual to use dune
2018-07-06 15:10:59 +07:00
Rudi Grinberg 4c0594caff
Port over the dune file description page to dune (#953) 2018-07-05 22:09:56 +07:00
Etienne Millon 2f5ac86c71 Rename jbuilder to dune in docs
This applies to the program name in text as well as CLI commands, but
not to existing jbuilder files.

Signed-off-by: Etienne Millon <etienne@cryptosense.com>
2018-07-02 10:02:01 +02:00
Jeremie Dimino 81bcd0f3e1 Add a "default" alias defined as follow:
- if "default" is specified by the user explicitely, use this
  definition
- otherwise assume the following definition:

  (alias
   (name default)
   (deps (alias_rec install)))

Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2018-07-01 21:50:44 +01:00
Jeremie Dimino 30db63ef71 Support @@alias to build an alias non-recursively
Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2018-07-01 21:50:44 +01:00
Jeremie Dimino 744430b684 Update doc
Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2018-07-01 01:46:32 +07:00
Jeremie Dimino 2982567639 Make the default build profile be dev
Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2018-06-28 11:23:10 +01:00
Rudi Grinberg e1cc944a93 Add an entry for custom build directories to the manual
Signed-off-by: Rudi Grinberg <rudi.grinberg@gmail.com>
2018-06-02 18:30:06 +07:00
Etienne Millon 4ab291d0b8 Fix sphinx warnings (#835)
* Fix markup
* Fix links
* Fix references
* Fix leading space
* Add missing code markup

Signed-off-by: Etienne Millon <etienne@cryptosense.com>
2018-06-01 14:24:35 +01:00
Etienne Millon 98b3e07efa Add an example for jbuilder utop
This clarifies the use case. This replaces the emacs flag with something
more likely to be used in a shell session: implicit bindings.

Closes #727

Signed-off-by: Etienne Millon <etienne@cryptosense.com>
2018-05-29 13:24:24 +02:00
Jérémie Dimino 4d8ca489be
Add support for environment & build profiles (#419) 2018-05-04 16:49:25 +01:00
Jérémie Dimino 325584adfc
Renaming to Dune (#721)
- install two identical binaries: jbuilder and dune
- rename the man pages to dune-*
- change the name in man pages
- change the name of libraries
- add support for dune-project files and add a dune-project file
- add support for dune-workspace files
- start updating the manual
- update the tests
2018-05-02 12:56:12 +01:00
Jérémie Dimino 9dd5ab74e4
[WIP] Load rules lazily (#370)
* Change jbuilder to load rules lazily

Rules are now loaded on a per directory basis as needed. This speed up
the start up time on large workspaces.

Does various refactoring as well.

* Simplify the handling of META files

We no longer generate a META.foo.from-jbuilder file. Nobody is using
this feature and it's making the new code more complicated.
2018-01-19 08:50:06 +00:00
Jérémie Dimino eab1ff6c7b
Add promote actions and include stanzas (#402)
Add a promote action that allows to copy over generated files as
source files and an include stanza allowing to include a file in a
jbuild file.
2018-01-15 13:24:25 +00:00
Jeremie Dimino 2b49123ae1 Update documentation to reflect cross compilation
Describes how to setup targets and toolchains and the changes to the workspace
syntax.
2018-01-01 22:34:41 +08:00
Rudi Grinberg a63276f5b3 Merge pull request #268 from janestreet/new-alias-semantic
Sort out recursive/non-recursive aliases
2017-10-19 15:33:23 +08:00
Rudi Grinberg f9025a401a Document utop command 2017-10-14 18:50:37 +08:00
Jeremie Dimino 8466924a73 Update doc 2017-10-14 10:37:36 +08:00
Rudi Grinberg 97511eb77b fix header for "running tests" 2017-10-10 16:15:50 -04:00
Jeremie Dimino cc0bf2dfb7 Rephrase the doc for (merlin) in jbuild-workspace
Related to #257
2017-09-22 12:20:22 +01:00
Jeremie Dimino 157e4d6548 Print "Entering directory '...'" when necessary
When the root of the workspace is not the current directory, print:

  Entering directory '<absolute path to root>'

This way editors such as emacs or vim knows how to interpret filenames
reported by the compiler.

Fixes #138
2017-09-22 01:59:45 +01:00
Jeremie Dimino b2e7720b41 Interpret empty jbuild-workspace files as default configuration
If a workspace file is empty, interpret it the same as if it contained:

  (context default)

As discussed in #234
2017-09-22 01:59:45 +01:00
Jeremie Dimino cfd43d5282 Simplify a bit the rules for installation of library files 2017-07-25 17:07:24 +01:00
François Bobot 44a15bcd24 Fix documentation for `--libdir` 2017-07-25 16:44:14 +01:00
François Bobot 747cf220c6 Install by specifying libdir for opam-installer
- change default findlib directory (ocamlc -where)
2017-07-25 16:44:14 +01:00
Tim McGilchrist a9f7166a2a Spelling 2017-06-16 14:20:06 +10:00
Jeremie Dimino 0cea06b5d2 Fix #125 2017-06-06 14:59:21 +01:00
Jeremie Dimino 7dc30d1184 Document `jbuilder subst` in the manual 2017-06-02 11:59:14 +01:00
Rudi Grinberg f98072deb7 Doc tweaks (#112)
* Fix a link and some typos
* Fix some crappy formatting introduced by the pandoc conversion.
* Use more subheadings rather than points.
2017-06-01 16:02:29 +01:00
Markus Mottl e63a6e4006 Command typo 2017-05-27 20:18:19 -04:00
Rudi Grinberg 1309a92ec5 Fix links in rst docs
Were not converted correctly by pandoc so they must be fixed manually
2017-05-19 08:25:46 +01:00
Rudi Grinberg 56093df13e Read The Docs
Port manual to RST to make it usable on readthedocs.

conf.py was only there to make it easy to preview changes if you have sphinx
installed.
2017-05-15 11:53:55 -04:00