Browse thread
[ANN] OCaml Batteries Included, alpha 3
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: | 2009-02-09 (12:31) |
From: | Daniel_Bünzli <daniel.buenzli@e...> |
Subject: | Re: ocamlbuild documentation (was Re: [Caml-list] Re: [ANN] OCaml Batteries Included, alpha 3) |
Le 9 févr. 09 à 12:51, Romain Bardou a écrit : > Is it just a matter of copy/pasting the contents of the wiki into > the OCaml manual? Are you serious ? > Or does the wiki really lacks important information? Yes, the way the plugin api works is still lagely undocumented (a random example is it possible to use Plugin.flag inside a rule and what would the effects be ? another is why is the tags argument of Plugin.rule deprectated and thus how can I make a rule apply only if a file has a given tag or maybe I shouldn't do that, etc.). There are a lot of things the authors of ocambuild know that are not in the wiki and that I don't want to discover by trial/error/ understand the ocamlbuild source/consult mailling list/try to look at the wiki and I'd be very grateful to them if they'd share this knowledge in a well-written manual. > As far as I can tell it does answer a lot of the questions you > highlighted. Many people don't understand that very often the barrier to adoption is just a single, extensive source of documentation called a manual. Let me repeat that again, a wiki (or its content) is not a substitute for a manual. The whole carefully edited "big picture" documentation is missing and you won't get that by copy and pasting random samples from the wiki. We need this well-written thing called a manual that any respectful tool should provide, they had a good start here [1] but it is not sufficient as it covers only the simplest cases. Daniel [1] http://nicolaspouillard.fr/ocamlbuild/ocamlbuild-user-guide.html