[Caml-list] Beware of compiler internals (Was: ocamldoc for ocaml's compiler?)

[Caml-list] Beware of compiler internals (Was: ocamldoc for ocaml's compiler?)

[Gabriel Scherer]

Dear list,

The new 4.00 release has added fairly interesting feature relying on
the compiler internals: the new -bin-annot option allowing to export
and manipulate the typedtree of an OCaml program has already stirred
interest among tools writers (see Jun Furuse's OCamlspotter changes,
or the questions of Hongbo Zhang).

I just wanted to remark that the interface those tools expose are
*not* stabilized and will *certainly* change before the next OCaml
release: this code is very young, not reliable (don't expect all
features to work as advertized), and flaws will certainly be
discovered and fixed.

To my knowledge, there is no compatibility guarantee coming from the
compiler writers. Please keep that in mind when experimenting with
those features: they are experimental, and if you decide to rely on
them everyone will be interested in your feedback, but you're on your
own and you should expect maintenance work (or even feature loss)
during the next few releases.

Regards -- from San Francisco.

On Thu, Jul 26, 2012 at 4:15 AM, Hongbo Zhang <bobzhang1988@gmail.com> wrote:
> On 7/25/12 11:13 PM, Hongbo Zhang wrote:
>>
>> On 7/25/12 7:12 PM, Hongbo Zhang wrote:
>>>
>>> Hi List,
>>>    Did anyone have a try to build ocamldoc's documentation for ocaml's
>>> compiler?
>>> Many Thanks
>>>
>> Hi, I managed to build documentation for ocaml compiler. Another problem
>> comes that ocamldoc prefers .mli to .ml which renders -keep-code not
>> useful.
>> Any ideas?
>> Once I finished, if people interested, I would be happy to share.
>> Thanks
>>
>>
> Hi,
>    I put it here
> http://www.seas.upenn.edu/~hongboz/hongbo_zhang_files/typing.docdir/index.html
>
>
>
> --
> Caml-list mailing list.  Subscription management and archives:
> https://sympa-roc.inria.fr/wws/info/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs
>

[Caml-list] Re: Beware of compiler internals (Was: ocamldoc for ocaml's compiler?)

[Hongbo Zhang]

Hi Gabriel,
    There are a lot of things to explore having compiler as libraries. 
(another advantage compared with Haskell)
Backward in-compatible is a minor issue if there's more documentation.

Best -- Hongbo Zhang
On 7/30/12 6:07 PM, Gabriel Scherer wrote:
> Dear list,
>
> The new 4.00 release has added fairly interesting feature relying on
> the compiler internals: the new -bin-annot option allowing to export
> and manipulate the typedtree of an OCaml program has already stirred
> interest among tools writers (see Jun Furuse's OCamlspotter changes,
> or the questions of Hongbo Zhang).
>
> I just wanted to remark that the interface those tools expose are
> *not* stabilized and will *certainly* change before the next OCaml
> release: this code is very young, not reliable (don't expect all
> features to work as advertized), and flaws will certainly be
> discovered and fixed.
>
> To my knowledge, there is no compatibility guarantee coming from the
> compiler writers. Please keep that in mind when experimenting with
> those features: they are experimental, and if you decide to rely on
> them everyone will be interested in your feedback, but you're on your
> own and you should expect maintenance work (or even feature loss)
> during the next few releases.
>
> Regards -- from San Francisco.
>
> On Thu, Jul 26, 2012 at 4:15 AM, Hongbo Zhang <bobzhang1988@gmail.com> wrote:
>> On 7/25/12 11:13 PM, Hongbo Zhang wrote:
>>>
>>> On 7/25/12 7:12 PM, Hongbo Zhang wrote:
>>>>
>>>> Hi List,
>>>>     Did anyone have a try to build ocamldoc's documentation for ocaml's
>>>> compiler?
>>>> Many Thanks
>>>>
>>> Hi, I managed to build documentation for ocaml compiler. Another problem
>>> comes that ocamldoc prefers .mli to .ml which renders -keep-code not
>>> useful.
>>> Any ideas?
>>> Once I finished, if people interested, I would be happy to share.
>>> Thanks
>>>
>>>
>> Hi,
>>     I put it here
>> http://www.seas.upenn.edu/~hongboz/hongbo_zhang_files/typing.docdir/index.html
>>
>>
>>
>> --
>> Caml-list mailing list.  Subscription management and archives:
>> https://sympa-roc.inria.fr/wws/info/caml-list
>> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
>> Bug reports: http://caml.inria.fr/bin/caml-bugs
>>
>