diff --git a/README.org b/README.org index 3d8541cc..f4948db6 100644 --- a/README.org +++ b/README.org @@ -148,6 +148,10 @@ that preserves composability; i.e. it doesn't require to manually run all =./configure= script when working on multiple projects at the same time. +*** Can I use topkg with jbuilder? + +Yes, have a look at the [[https://github.com/diml/topkg-jbuilder][topkg-jbuilder]] project for more details. + ** Known bugs *** Optional libraries inside a multilib directory diff --git a/ROADMAP.org b/ROADMAP.org index 9823d1af..5df6e8a8 100644 --- a/ROADMAP.org +++ b/ROADMAP.org @@ -80,10 +80,26 @@ So that we can filter tests when using =-p pkg= https://github.com/janestreet/jbuilder/pull/23 -** Integrate rules for js_of_ocaml +** +Integrate rules for js_of_ocaml+ https://github.com/janestreet/jbuilder/pull/60 +- *02/05/2017*: Merged + +** +Topkg integration+ + +It would be nice to integrate with [[http://erratique.ch/software/topkg][topkg]]. Some of the features +overlap, and for instance there doesn't seem to be much point in using +topkg to generate the .install or invoke jbuilder since jbuilder +already handles that well. However, the other features available +through the =topkg= command line tool would be good to have. + +- *08/05/2017*: Made topkg and jbuilder work together with [[https://github.com/diml/topkg-jbuilder][topkg-jbuilder]] + +** odoc support + +Support generating documentation with [[https://github.com/ocaml-doc/odoc][odoc]]. + * After V1 ** Cross-compilation @@ -105,23 +121,11 @@ as follows: (host foo))) #+end_src -** Topkg integration - -It would be nice to integrate with [[http://erratique.ch/software/topkg][topkg]]. Some of the features -overlap, and for instance there doesn't seem to be much point in using -topkg to generate the .install or invoke jbuilder since jbuilder -already handles that well. However, the other features available -through the =topkg= command line tool would be good to have. - ** Jenga bridge Implement a jenga plugin that can read the same jbuild files as Jbuilder. To do that we'll use Jbuilder as a library. -** odoc support - -Support generating documentation with [[https://github.com/ocaml-doc/odoc][odoc]]. - ** Inline tests Setup automatic support of [[https://github.com/janestreet/ppx_inline_test][inline tests]] and [[https://github.com/janestreet/ppx_bench][inline benchmarks]]. diff --git a/doc/manual.org b/doc/manual.org index 9ff5c6a8..4e938702 100644 --- a/doc/manual.org +++ b/doc/manual.org @@ -175,6 +175,11 @@ The version file can be generated by a user rule. If the version can't be determined, Jbuilder just won't assign one. +Note that if you are using [[https://github.com/dbuenzli/topkg][Topkg]] as well in your project, you +shouldn't manually set a version in your =.opam= file or +write/generate on of the file listed above. See [[Using topkg with jbuilder][the section about +using topkg with jbuilder]] for more details. + *** Odig conventions Jbuilder follows the [[http://erratique.ch/software/odig][odig]] conventions and automatically installs any @@ -1373,6 +1378,15 @@ way to control this behaviour. See the [[Js_of_ocaml][section about js_of_ocaml]] for passing custom flags to the js_of_ocaml compiler +** Using topkg with jbuilder + +Jbuilder provides suport for building and installing your +project. However it doesn't provides helpers for distributing it. It +is recommemded to use [[https://github.com/dbuenzli/topkg][Topkg]] for this purpose. + +The [[https://github.com/diml/topkg-jbuilder][topkg-jbuilder]] project provides helpers for using Topkg in a +Jbuilder project. + * Advanced topics This section describes some details of Jbuilder for advanced users.