From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.1.3 (2006-06-01) on yquem.inria.fr X-Spam-Level: X-Spam-Status: No, score=0.1 required=5.0 tests=AWL autolearn=disabled version=3.1.3 X-Original-To: caml-list@yquem.inria.fr Delivered-To: caml-list@yquem.inria.fr Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by yquem.inria.fr (Postfix) with ESMTP id 84052BB84 for ; Mon, 9 Feb 2009 12:51:16 +0100 (CET) X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AmgDAPumj0mBrw8EgWdsb2JhbACUOQEBFiK5VYQaBg X-IronPort-AV: E=Sophos;i="4.37,405,1231110000"; d="scan'208";a="22697792" Received: from ext.lri.fr ([129.175.15.4]) by mail3-smtp-sop.national.inria.fr with ESMTP/TLS/ADH-AES256-SHA; 09 Feb 2009 12:51:16 +0100 Received: from localhost (localhost [127.0.0.1]) by ext.lri.fr (Postfix) with ESMTP id EA4EAA43AA for ; Mon, 9 Feb 2009 12:51:15 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at lri.fr Received: from ext.lri.fr ([127.0.0.1]) by localhost (ext.lri.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 6tpPv5L9uoSB for ; Mon, 9 Feb 2009 12:51:15 +0100 (CET) Received: from smtp.lri.fr (vhost3-23 [129.175.3.23]) by ext.lri.fr (Postfix) with ESMTP id D2C49A438B for ; Mon, 9 Feb 2009 12:51:15 +0100 (CET) Received: from [129.175.4.107] (lri4-107 [129.175.4.107]) by smtp.lri.fr (Postfix) with ESMTP id DFCA2E0570 for ; Mon, 9 Feb 2009 12:51:15 +0100 (CET) Message-ID: <499018C2.9080007@lri.fr> Date: Mon, 09 Feb 2009 12:51:30 +0100 From: Romain Bardou User-Agent: Thunderbird 2.0.0.19 (X11/20090105) MIME-Version: 1.0 To: OCaml List Subject: Re: ocamlbuild documentation (was Re: [Caml-list] Re: [ANN] OCaml Batteries Included, alpha 3) References: <1233936696.6216.65.camel@Blefuscu> <200902071458.45000.jon@ffconsultancy.com> <498FF839.6090901@lri.fr> In-Reply-To: Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-Spam: no; 0.00; lri:01 ocaml:01 lacks:01 wikis:01 toolchain:01 ocaml's:01 wiki:01 ocaml:01 wiki:01 lacks:01 highlighted:98 caml-list:01 caml:02 philosophy:02 precedent:05 > Simple projects are not the problem. The plugin interface lacks > documentation. Well I would like to know what "simple things" Jon could not do then. > Wikis are nice but not are no substitute for real documentation. The > designers of ocamlbuild should once take the time to thoroughly explain > and document the philosophy and workings of ocamlbuild; how does it > work, what is the right way to do thing, what is the wrong way to do > things, how do I achieve this etc. > > So far every program of the caml toolchain had sufficiently clear > documentation in ocaml's manual. With respect to that ocamlbuild is an > unwelcomed precedent. Is it just a matter of copy/pasting the contents of the wiki into the OCaml manual? Or does the wiki really lacks important information? As far as I can tell it does answer a lot of the questions you highlighted. -- Romain Bardou