[Caml-list] ocamldoc doesn't show up for the Unix module in ocp-browser

[Caml-list] ocamldoc doesn't show up for the Unix module in ocp-browser

[Francois BERENGER]

Hello,

Is this an installation problem with the stdlib?

Apparently, the ocamldoc is missing for the Unix module.
While it's there for other modules I tried (List and Array for example).

I'm using ocaml-4.01.0 via opam.

Usually, in ocp-browser, hitting the space bar shows the ocamldoc
for the given entry.

Am I the only one seeing this?

Regards,
F.

[Caml-list] Why is there no Marshal.(from_fd|to_fd)

[Francois BERENGER]

Hello,

Sorry for the maybe stupid question.

I mean fd has type Unix.file_descr.

I am just wondering why marshaling has to always go through an in or 
out_channel.

Is it just so that there is not dependency between the Marshal and the 
Unix module?

I am worried about the data copying that might happen because
of the channel interposed between me and my file.

Regards,
F.

Re: [Caml-list] Why is there no Marshal.(from_fd|to_fd)

[Ivan Gotovchits]

[-- Attachment #1: Type: text/plain, Size: 1556 bytes --]

Hi,

The main reason is that marshaling is a part of standard library, i.e., the
stdlib.cma, where Unix.file_descr is a part of the unix library, and the
Unix library is not included into the Standard library, thus the latter
cannot depend on the former. So, the only way to introduce such
functionality would be to add Unix.dump_value : file_descr -> 'a -> unit`,
i.e., to the Unix module. It is doable, and I saw such function in
third-party libraries and implemented it myself. There is a small issue
with the buffering, as all file_descr operations are unbuffered and it is
assumed that the do not create any intermediate storages. But the only way
to implement the dump_value function is to use an intermediate buffer, that
kind of contradicts the general spirit of the file_descr interface.

Regards,
Ivan Gotovchits

On Tue, Jun 13, 2017 at 11:01 AM, Francois BERENGER <
berenger@bioreg.kyushu-u.ac.jp> wrote:

> Hello,
>
> Sorry for the maybe stupid question.
>
> I mean fd has type Unix.file_descr.
>
> I am just wondering why marshaling has to always go through an in or
> out_channel.
>
> Is it just so that there is not dependency between the Marshal and the
> Unix module?
>
> I am worried about the data copying that might happen because
> of the channel interposed between me and my file.
>
> Regards,
> F.
>
> --
> Caml-list mailing list.  Subscription management and archives:
> https://sympa.inria.fr/sympa/arc/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs
>

[-- Attachment #2: Type: text/html, Size: 2337 bytes --]

Re: [Caml-list] ocamldoc doesn't show up for the Unix module in ocp-browser

[louis.gesbert]

Apparently, the `.cmt` for Unix don't get installed as for the other modules 
of the stdlib. ocp-index/ocp-browser extracts the docstrings directly from 
there, which explains the results.

On mardi 13 juin 2017 15:16:14 CEST Francois BERENGER wrote:
> Hello,
> 
> Is this an installation problem with the stdlib?
> 
> Apparently, the ocamldoc is missing for the Unix module.
> While it's there for other modules I tried (List and Array for example).
> 
> I'm using ocaml-4.01.0 via opam.
> 
> Usually, in ocp-browser, hitting the space bar shows the ocamldoc
> for the given entry.
> 
> Am I the only one seeing this?
> 
> Regards,
> F.

Re: [Caml-list] ocamldoc doesn't show up for the Unix module in ocp-browser

[Daniel Bünzli]

On 14 June 2017 at 12:34:32, louis.gesbert@ocamlpro.com (louis.gesbert@ocamlpro.com) wrote:

> Apparently, the `.cmt` for Unix don't get installed as for the other modules
> of the stdlib. ocp-index/ocp-browser extracts the docstrings directly from
> there, which explains the results.

If it also looks up cmti files. This should have been solved from 4.04 on. See 

https://caml.inria.fr/mantis/view.php?id=7362

Best,

Daniel

Re: [Caml-list] ocamldoc doesn't show up for the Unix module in ocp-browser

[Francois BERENGER]

On 06/14/2017 10:13 PM, Daniel Bünzli wrote:
> On 14 June 2017 at 12:34:32, louis.gesbert@ocamlpro.com (louis.gesbert@ocamlpro.com) wrote:
> 
>> Apparently, the `.cmt` for Unix don't get installed as for the other modules
>> of the stdlib. ocp-index/ocp-browser extracts the docstrings directly from
>> there, which explains the results.
> 
> If it also looks up cmti files. This should have been solved from 4.04 on. See
> 
> https://caml.inria.fr/mantis/view.php?id=7362

Ok, there are no .cmt/.cmti files installed for the unix module.

I opened a bug in mantis:
https://caml.inria.fr/mantis/view.php?id=7556

Thanks for the feedback Louis and Daniel.

Regards,
F.

Re: [Caml-list] ocamldoc doesn't show up for the Unix module in ocp-browser

[Louis Gesbert]

Yes, the cmti should be sufficient.

> - Daniel Bünzli, 14/06/2017 14:13 -
> On 14 June 2017 at 12:34:32, louis.gesbert@ocamlpro.com (louis.gesbert@ocamlpro.com) wrote:
> 
> > Apparently, the `.cmt` for Unix don't get installed as for the other modules
> > of the stdlib. ocp-index/ocp-browser extracts the docstrings directly from
> > there, which explains the results.
> 
> If it also looks up cmti files. This should have been solved from 4.04 on. See 
> 
> https://caml.inria.fr/mantis/view.php?id=7362
> 
> Best,
> 
> Daniel
> 
>