caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Gabriel Kerneis <gabriel@kerneis.info>
To: Gabriel Scherer <gabriel.scherer@gmail.com>
Cc: Romain Bardou <romain.bardou@inria.fr>, caml users <caml-list@inria.fr>
Subject: Re: [Caml-list] ocamlbuild documentation (was: OCaml release 4.01.0)
Date: Thu, 12 Sep 2013 16:41:12 +0100	[thread overview]
Message-ID: <20130912154112.GA28924@kerneis.info> (raw)
In-Reply-To: <CAPFanBHUyQ1=Bn3xf6gCXD_PGO4xRAw3SXCstod+dtmnVBo-Ag@mail.gmail.com>

Hi Gabriel,

On Thu, Sep 12, 2013 at 05:25:30PM +0200, Gabriel Scherer wrote:
> Note that the "ocamlbuild API" is mostly meant for rather advanced users
> (which should be comfortable reading a .mli file in their favorite text
> editor).

I disagree with that. I enjoy much more browsing ocamldoc's output than an mli
file, mostly because of hyperlinks, and I'm not always developping on computers
where I can, or wish to, rebuild it.

Moreover, if ocamlbuild is part of the standard ocaml distribution, I don't
understand why its API is not hosted on http://caml.inria.fr/. What would it
take it to dump to http://caml.inria.fr/pub/docs/manual-ocamlbuild/libref/ [*]
just like http://caml.inria.fr/pub/docs/manual-ocaml/libref/ contains stdlib's
API?

[*] or maybe http://caml.inria.fr/pub/docs/manual-ocaml/ocamlbuildref/ 

>   https://github.com/gasche/manual-ocamlbuild
> 
> (I had planned to give myself more time to improve this documentation
> draft, before making a call to contributions on the list, but your message
> prompted an earlier response. Thanks for your interest.)

Thank you some much for your effort. I think it deserves its own email on this
list (maybe in a few weeks) to gather more attention and feedback.

-- 
Gabriel

  reply	other threads:[~2013-09-12 15:41 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-12 15:25 Gabriel Scherer
2013-09-12 15:41 ` Gabriel Kerneis [this message]
2013-09-12 17:14   ` Romain Bardou

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=20130912154112.GA28924@kerneis.info \
    --to=gabriel@kerneis.info \
    --cc=caml-list@inria.fr \
    --cc=gabriel.scherer@gmail.com \
    --cc=romain.bardou@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).