public inbox for cocci@systeme.lip6.fr
 help / color / mirror / Atom feed
From: elfring@users.sourceforge.net (SF Markus Elfring)
To: cocci@systeme.lip6.fr
Subject: [Cocci] Addition of source code documentation generation to the build system?
Date: Tue, 05 Mar 2013 18:08:30 +0100	[thread overview]
Message-ID: <5136268E.50602@users.sourceforge.net> (raw)
In-Reply-To: <CANrVCd1rFXSmrtCCWq6K8E81wSq6n1MdztQuN-9vY16dBtsd_A@mail.gmail.com>

> I'm sorry but configure generates only constants containing paths,
> which specify - depending on the system configuration and preferences
> - where binaries/sources of various packages are located.

The Autotools infrastructure ensures that these macros will be applied by
Makefiles at the appropriate places.


> It does not generate invocations of the ocaml compiler nor of ocamldoc.

I agree because these tools do not belong to software which are supported by the
autoconf build system by default. I guess that this can be added by adjustments
of ".in" (or ".am" eventually) files easily.
http://www.gnu.org/software/automake/manual/html_node/automake-Invocation.html


> Like with all other tools, in order to use ocamldoc you'll need to
> make sure that it gets the appropriate inputs, such as compiled
> interface files.

I find it a technical challenge at the moment to collect the needed parameters
in a consistent way.


> However, it will involve manual labour.

I hope to avoid that.


> When I tried it once, ocamldoc failed to parse some sources, so you
> cannot expect it to handle evertything.

Thanks for your background information.


> As I wrote before, ocamlbuild has some hidden magic for documentation
> generation. So if you can get coccinelle to build with it, you might
> get documentation out as well without having to do a lot of work. Note
> that we do not officially support ocamlbuild so if it does not work
> for you, you can forget this last paragraph.

I hope that this aspect will change in the future.

Regards,
Markus

  reply	other threads:[~2013-03-05 17:08 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-03 20:21 [Cocci] Addition of source code documentation generation to the build system? SF Markus Elfring
2013-03-04 10:10 ` Julia Lawall
2013-03-04 12:20   ` SF Markus Elfring
2013-03-04 12:42     ` Julia Lawall
2013-03-04 12:57       ` SF Markus Elfring
2013-03-04 13:09         ` Julia Lawall
2013-03-05  9:20       ` SF Markus Elfring
2013-03-05  9:30         ` Julia Lawall
2013-03-05  9:55           ` SF Markus Elfring
2013-03-05 10:06             ` Julia Lawall
2013-03-05 10:22               ` SF Markus Elfring
2013-03-05 10:28                 ` Julia Lawall
2013-03-05 10:42                   ` SF Markus Elfring
2013-03-05 10:49                     ` Julia Lawall
2013-03-05 13:24                       ` SF Markus Elfring
2013-03-05 16:34                         ` Arie Middelkoop
2013-03-05 17:08                           ` SF Markus Elfring [this message]
2013-03-05 20:44                           ` SF Markus Elfring
2013-03-07  9:55                             ` SF Markus Elfring
2013-03-05 16:01                       ` SF Markus Elfring

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=5136268E.50602@users.sourceforge.net \
    --to=elfring@users.sourceforge.net \
    --cc=cocci@systeme.lip6.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