From: "Daniel Bünzli" <daniel.buenzli@erratique.ch>
To: OCaml List <caml-list@yquem.inria.fr>
Subject: Re: ocamlbuild documentation (was Re: [Caml-list] Re: [ANN] OCaml Batteries Included, alpha 3)
Date: Mon, 9 Feb 2009 13:30:54 +0100 [thread overview]
Message-ID: <D1169181-2A0A-412A-8980-EC0A7B8931C5@erratique.ch> (raw)
In-Reply-To: <499018C2.9080007@lri.fr>
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
next prev parent reply other threads:[~2009-02-09 12:31 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-02-06 16:11 [ANN] OCaml Batteries Included, alpha 3 David Rajchenbach-Teller
2009-02-07 14:21 ` [Caml-list] " Mikkel Fahnøe Jørgensen
2009-02-07 14:43 ` Sylvain Le Gall
2009-02-07 14:58 ` [Caml-list] " Jon Harrop
2009-02-07 15:13 ` Sylvain Le Gall
2009-02-07 16:13 ` [Caml-list] " Matthieu Dubuget
2009-02-07 19:30 ` David Rajchenbach-Teller
2009-02-07 21:13 ` Matthieu Dubuget
2009-02-09 9:36 ` Romain Bardou
2009-02-09 15:56 ` David Teller
2009-02-07 15:46 ` Paolo Donadeo
2009-02-09 9:32 ` Romain Bardou
2009-02-09 10:30 ` ocamlbuild documentation (was Re: [Caml-list] Re: [ANN] OCaml Batteries Included, alpha 3) Daniel Bünzli
2009-02-09 11:51 ` Romain Bardou
2009-02-09 12:30 ` Daniel Bünzli [this message]
2009-02-09 12:52 ` Romain Bardou
2009-02-09 13:07 ` Daniel Bünzli
2009-02-09 13:22 ` Romain Bardou
2009-02-09 13:36 ` Daniel Bünzli
2009-02-09 13:59 ` Romain Bardou
2009-02-09 14:04 ` Romain Bardou
2009-02-09 14:37 ` Daniel Bünzli
2009-02-09 17:26 ` Kuba Ober
2009-02-09 18:28 ` Jon Harrop
2009-02-09 21:24 ` DooMeeR
2009-02-10 14:06 ` ocamlbuild documentation Jan Kybic
2009-02-10 14:27 ` [Caml-list] " Matthieu Dubuget
[not found] ` <87k57ywc0k.fsf@fel.cvut.cz>
2009-02-10 15:50 ` Matthieu Dubuget
2009-02-10 15:58 ` Daniel Bünzli
2009-02-09 18:38 ` ocamlbuild documentation (was Re: [Caml-list] Re: [ANN] OCaml Batteries Included, alpha 3) David Teller
2009-02-09 22:02 ` [Caml-list] Re: [ANN] OCaml Batteries Included, alpha 3 Peter Hawkins
2009-02-09 22:45 ` Mikkel Fahnøe Jørgensen
2009-02-09 22:55 ` Mikkel Fahnøe Jørgensen
2009-02-10 7:48 ` Stefano Zacchiroli
2009-02-10 13:22 ` Mikkel Fahnøe Jørgensen
2009-02-07 20:04 ` Daniel Bünzli
2009-02-08 17:22 ` [Caml-list] " Richard Jones
2009-02-09 8:57 ` David Allsopp
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=D1169181-2A0A-412A-8980-EC0A7B8931C5@erratique.ch \
--to=daniel.buenzli@erratique.ch \
--cc=caml-list@yquem.inria.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).