From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Original-To: caml-list@sympa.inria.fr Delivered-To: caml-list@sympa.inria.fr Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by sympa.inria.fr (Postfix) with ESMTPS id 2AD7381792 for ; Sun, 7 Jul 2013 19:38:12 +0200 (CEST) Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of daniel.buenzli@erratique.ch) identity=pra; client-ip=74.55.86.74; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="daniel.buenzli@erratique.ch"; x-conformance=sidf_compatible Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of daniel.buenzli@erratique.ch) identity=mailfrom; client-ip=74.55.86.74; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="daniel.buenzli@erratique.ch"; x-conformance=sidf_compatible Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of postmaster@smtp.webfaction.com) identity=helo; client-ip=74.55.86.74; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="postmaster@smtp.webfaction.com"; x-conformance=sidf_compatible X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Aq0DACGm2VFKN1ZKamdsb2JhbABagzsBg1G9WIEeDgsLDAYUKoIjAQEEASNWBQsLGgImAgJHEAYbiAEGBAinYpA/gSaOEjMHglMzaQOYfIRnE443 X-IPAS-Result: Aq0DACGm2VFKN1ZKamdsb2JhbABagzsBg1G9WIEeDgsLDAYUKoIjAQEEASNWBQsLGgImAgJHEAYbiAEGBAinYpA/gSaOEjMHglMzaQOYfIRnE443 X-IronPort-AV: E=Sophos;i="4.87,1014,1363129200"; d="scan'208";a="20278647" Received: from mail6.webfaction.com (HELO smtp.webfaction.com) ([74.55.86.74]) by mail3-smtp-sop.national.inria.fr with ESMTP; 07 Jul 2013 19:38:10 +0200 Received: from [192.168.1.126] (cpc3-cmbg9-0-0-cust324.5-4.cable.virginmedia.com [81.103.21.69]) by smtp.webfaction.com (Postfix) with ESMTP id 48D7B66EFDE5; Sun, 7 Jul 2013 17:38:05 +0000 (UTC) Date: Sun, 7 Jul 2013 18:38:03 +0100 From: =?utf-8?Q?Daniel_B=C3=BCnzli?= To: Dagnat Fabien Cc: "=?utf-8?Q?caml-list=40inria.fr?=" Message-ID: In-Reply-To: <8D4165F2-D097-4497-AD9F-18AFA1E21266@telecom-bretagne.eu> References: <8D4165F2-D097-4497-AD9F-18AFA1E21266@telecom-bretagne.eu> X-Mailer: sparrow 1.6.4 (build 1178) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline Subject: Re: [Caml-list] =?UTF-8?Q?man=2C_doc=2C_=E2=80=A6_and_opam?= Hello, Incidentally I learned more about all this today. > After reading the opam documentation, I'm not sure anything specific has = been done about the extra resources of packages (man and doc files for exam= ple). Some things have been done, read section 1.2.5 of the developer manual. An = install file allow you to specify exactly what to install and where in `bin= `, `doc` and `lib`.=20=20 In fact this it can completely replace an `ocamlfind install` or `ocaml set= up.ml -install`. Just make sure you add the `META` in `lib`, and `ocamlfind= ` will find your package. I also discovered that the `remove:` section with the usual `ocamlfind remo= ve PKG` is not needed. This is all due to the fact the IIUC `ocamlfind` us= es the file system as the database so there's no worry to bypass it in thes= e circumstances, opam will just remove the lib/PKG directory et voil=C3=A0. =20=20 > The only things, I found in the documentation is build-doc switch to indi= cate how to build the doc. For example, utop.1.5.opam contains > build-doc: [ "ocaml" "setup.ml" "-doc" ] >=20=20 > I was expecting to find the doc of utop but on my .opam repository, the d= oc directory of utop is empty. Furthermore, in the utop.install file there = is no doc command. The problem is that apparently the utop package has a static .install file = in the package description and that this file doesn't list the things gener= ated by build-doc in the `doc:` section. As written in the manual section m= entioned above it's much better if the .install file is actually generated = by the underlying build system according to the artefacts it has built. But= to the best of my knowledge none of the current build systems in use suppo= rt the generation of such a file (you can easily do it yourself though). So the idea is that the `build:` section has commands that eventually gener= ate a file PKG.install in the root directory of your distribution and opam = then uses that file to install the files associated to the package. (Unfort= unately the example of the online documentation uses an static .install fil= e added to the package description *itself* which makes it believe that thi= s was the only way to use them). > More generally, my question also apply to man pages not found anywhere in= the opam documentation. I have created an issue about this a few hours ago: https://github.com/OCam= lPro/opam/issues/673 I think the support is mostly right, the only thing that is missing is inst= all in man folders and a way to easily get to the doc directory of a partic= ular package, instead of having to hunt in the .opam directory. This means = that we can put the README and CHANGES in there aswell for people to read. The conclusion of this is that the problem seems more to be that the instal= l file of most packages is crap rather than a lack of support from opam its= elf. Though the documentation about all this could be improved on the opam = side aswell. Best, Daniel