caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Gabriel Scherer <gabriel.scherer@gmail.com>
To: caml users <caml-list@inria.fr>
Subject: [Caml-list] New ocamlbuild manual -- a usable draft
Date: Sat, 12 Sep 2015 21:23:39 +0200	[thread overview]
Message-ID: <CAPFanBFgLeONPBoRjvNxdDPYSYxQAkx0ytrFSY+Dtkg6yZZ1sw@mail.gmail.com> (raw)

Hi all,

In August 2013 I started working on-and-off (mostly off) on a new
ocamlbuild manual, given that many users were not satisfied with the
existing documentation.

  https://github.com/gasche/manual-ocamlbuild/blob/master/manual.md

The project is now reaching a state where I think it should be usable
by any ocamlbuild user as a documentation starting point. I am
thinking of "releasing" it in the following weeks/months by pushing it
in a more authoritative place than a personal github repository.

More than ever, I am highly interested in feedback and contributions
on this manual.

(I think the manual still lacks some content that I initially planned
to include. In particular, I would like to eventually have a skeleton
of example of a project with a non-trivial mix of C and OCaml code. I
myself don't know much about these so I didn't delay a "release" for
it.)

In the course of writing this manual I have done some improvements to
ocamlbuild's auto-documentation engine (the -documentation
command-line flag) to support parametrized flags, which are not part
of a released ocamlbuild version (feedback welcome on
https://github.com/ocaml/ocaml/pull/231 ) and extended some of the
.mli documentation (to which Cristophe Troestler had already made
great contributions, PR#5243) with examples of tags/rules declarations
for plugin authors.

Happy builds.

                 reply	other threads:[~2015-09-12 19:24 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=CAPFanBFgLeONPBoRjvNxdDPYSYxQAkx0ytrFSY+Dtkg6yZZ1sw@mail.gmail.com \
    --to=gabriel.scherer@gmail.com \
    --cc=caml-list@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).