From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 D3AF97F029 for ; Fri, 30 Sep 2016 11:01:28 +0200 (CEST) Authentication-Results: mail3-smtp-sop.national.inria.fr; spf=None smtp.pra=Fabrice.Le_fessant@inria.fr; spf=Pass smtp.mailfrom=fabrissimo@gmail.com; spf=None smtp.helo=postmaster@mail-wm0-f41.google.com Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of Fabrice.Le_fessant@inria.fr) identity=pra; client-ip=74.125.82.41; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="fabrissimo@gmail.com"; x-sender="Fabrice.Le_fessant@inria.fr"; x-conformance=sidf_compatible Received-SPF: Pass (mail3-smtp-sop.national.inria.fr: domain of fabrissimo@gmail.com designates 74.125.82.41 as permitted sender) identity=mailfrom; client-ip=74.125.82.41; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="fabrissimo@gmail.com"; x-sender="fabrissimo@gmail.com"; x-conformance=sidf_compatible; x-record-type="v=spf1" Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of postmaster@mail-wm0-f41.google.com) identity=helo; client-ip=74.125.82.41; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="fabrissimo@gmail.com"; x-sender="postmaster@mail-wm0-f41.google.com"; x-conformance=sidf_compatible IronPort-PHdr: =?us-ascii?q?9a23=3AKYM+1h9dyPY/BP9uRHKM819IXTAuvvDOBiVQ1KB8?= =?us-ascii?q?1+0cTK2v8tzYMVDF4r011RmSDN+dsasP07qempujcFRI2YyGvnEGfc4EfD4+ou?= =?us-ascii?q?JSoTYdBtWYA1bwNv/gYn9yNs1DUFh44yPzahANS47AblHf6ke/8SQVUk2mc1Ek?= =?us-ascii?q?fKKvQ8WK34ye7KObw9XreQJGhT6wM/tZDS6dikHvjPQQmpZoMa0ryxHE8TNicu?= =?us-ascii?q?VSwn50dxrIx06vru/5xpNo8jxRtvQ97IYAFPyiJ+Vre4dFFywrOHwZ48jitB+L?= =?us-ascii?q?DVfepyhUbmJDuxxJB0Dg5R36V4n4qib2uvs1jCCcPMneV70/XjWmqaBxR0mswA?= =?us-ascii?q?sOMT809Fb9HspiiKMT9B6ooR1yx8jefYyTJv5/Vq7HZ9oGRHNcU4BaV3oSLJm7?= =?us-ascii?q?at4hBuAbPO1V563w73UDtgC3AxXkUM3mwCVJjXKw+aAN3ek6CgjAwCQhGcgPuT?= =?us-ascii?q?LatoOmZ+8pTempwfyQnn34ZPRM1GK4tdHF?= X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0DrAAB6Ke5XfylSfUpdGQEBAQEBAQEBA?= =?us-ascii?q?QEBBwEBAQEBFQEBAQECAQEBAQgBAQEBgxQBAQEBAWcOfI0yln6CKiqMPYUSgh8?= =?us-ascii?q?BCoJEgmyCLjgUAQEBAQEBAQEBAQESAQEJCwsJFzGCMgQBFQWCEAEBAQMBAQEBD?= =?us-ascii?q?xFLCwULCwsNDRYHAgIiBQEMAQUBChIGARIIChCIEQMPCA6jP4EyPjKLPYkMA4N?= =?us-ascii?q?fCwEBAQEiEIp8h0iCPR0FhmsMhz+LQl6FSYVSg3eBbk6EGIkdhwqBa4N4gjsxg?= =?us-ascii?q?REPD1CDN4E4PjQBhTGBQQEBAQ?= X-IPAS-Result: =?us-ascii?q?A0DrAAB6Ke5XfylSfUpdGQEBAQEBAQEBAQEBBwEBAQEBFQE?= =?us-ascii?q?BAQECAQEBAQgBAQEBgxQBAQEBAWcOfI0yln6CKiqMPYUSgh8BCoJEgmyCLjgUA?= =?us-ascii?q?QEBAQEBAQEBAQESAQEJCwsJFzGCMgQBFQWCEAEBAQMBAQEBDxFLCwULCwsNDRY?= =?us-ascii?q?HAgIiBQEMAQUBChIGARIIChCIEQMPCA6jP4EyPjKLPYkMA4NfCwEBAQEiEIp8h?= =?us-ascii?q?0iCPR0FhmsMhz+LQl6FSYVSg3eBbk6EGIkdhwqBa4N4gjsxgREPD1CDN4E4PjQ?= =?us-ascii?q?BhTGBQQEBAQ?= X-IronPort-AV: E=Sophos;i="5.31,271,1473112800"; d="scan'208,217";a="195168126" Received: from mail-wm0-f41.google.com ([74.125.82.41]) by mail3-smtp-sop.national.inria.fr with ESMTP/TLS/AES128-GCM-SHA256; 30 Sep 2016 11:00:59 +0200 Received: by mail-wm0-f41.google.com with SMTP id b80so30863403wme.0; Fri, 30 Sep 2016 02:00:59 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=bYkZg8Tbzi54om47/sW4A5VjfTYVzTIrjhoY4syRKuM=; b=dZFW/klC85mwnEP/BxokwoPa1cCsDqXJPa48aRC49Gjmi+QQZT1xC8cSjqTvem1ilD 4vbDSHYe2XdaOLyL1SDHQ8iUoMqMSQS+IB/1zDmRj3A8m8259ubWIoL/g14hfcAhLIob DrHTsCt19e5JC/8quDv1E0a548t4JRnhKGiB5JMJnwTIid5RXDbx9I0vq1/9/4NP9YnK /GSrJADqqmmGaZAXrLHqpRJv1OEJnM5qWflsjM5CxK8uadsNyeYP4+z7W2IT82rHUXid wV6pb+gSuAB42JOgqslwZ3JvqXfC3aQlpTf6aRYmWYDn4IEmDEUCwkgdZdD2aCkLkLeI lPhA== X-Gm-Message-State: AA6/9Rl4W/NC10JzARtzODzDo36c2CGec+rHNHAu6gQ1sKePY4FDLp6bDaLx+xKd5d4RKI8lZ1HgnksyI2B/LA== X-Received: by 10.28.212.129 with SMTP id l123mr3048180wmg.22.1475226058655; Fri, 30 Sep 2016 02:00:58 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Fabrice Le Fessant Date: Fri, 30 Sep 2016 09:00:48 +0000 Message-ID: To: Anil Madhavapeddy , =?UTF-8?Q?Daniel_B=C3=BCnzli?= Cc: OCaml List , Maxence Guesdon , mirageos-devel Content-Type: multipart/alternative; boundary=001a114697e6308ff3053db5d595 Subject: Re: [Caml-list] [MirageOS-devel] [RE-ANN] From opkg to odig v0.0.1 (was Re: [ANN] opkg v0.0.1 - Documentation access improvements) --001a114697e6308ff3053db5d595 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Hi, Looking briefly at the two websites, the differences are not obvious. Cou= ld you describe a little the differences between the two tools ? Is one of them more precise than the other one ? Is one of them easier to use ? FWIW, `ocp-browser` can also be used to browse the API/documentation of installed packages in a terminal: see a screenshot at https://www.typerex.org/ocp-index.html#ocp-browser --Fabrice On Thu, Sep 29, 2016 at 5:14 PM Anil Madhavapeddy wrote: > Dear all, > > I have deployed an experimental documentation build for MirageOS libraries > (and dependencies thereof) using odig at: > > http://docs.mirage.io > > an experimental build using odoc (the new cross-referencing tool that is > still being worked on, so expected rendering bugs) is available under: > > http://docs.mirage.io/odoc/ > > These URLs are all subject to change, but I thought it might be useful to > see the generated output for a real project. The Dockerfile that generat= es > this site is at: > https://github.com/mirage/mirage/blob/master/Dockerfile.doc > > regards, > Anil > > > On 27 Sep 2016, at 20:34, Daniel B=C3=BCnzli > wrote: > > > > Hello, > > > > Due to concerns over a binary name clash with OpenWRT's package manager > [1], the opkg project > > was renamed to odig. > > > > http://erratique.ch/software/odig > > > > If you have installed opkg the way out is: > > > > opkg cache clear > > opam remove opkg > > opam update && opam install odig > > odig ocamldoc > > odig doc > > > > Thanks to David Kaloper Mer=C5=A1injak and Peter Zotov for raising > > the issue. > > > > Sorry for the inconvenience and happy doc digging, > > > > Daniel > > > > P.S. To package devs if there are issues with the way your docs get > rendered please get in touch on the issue tracker (if that's not due to > your package install or an ocamldoc issue itself). > > > > [1] https://wiki.openwrt.org/doc/techref/opkg > > > > _______________________________________________ > > MirageOS-devel mailing list > > MirageOS-devel@lists.xenproject.org > > https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel > > > -- > 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 --001a114697e6308ff3053db5d595 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable
Hi,

=C2=A0=C2=A0Looking briefly at the two websites, the differences are not obvio= us.=C2=A0Could you describe a little= the differences between the two tools ? Is one of them more precise than t= he other one ? Is one of them easier to use ?

= FWIW, `ocp-browser` can also be used to browse the API/documentation of ins= talled packages in a terminal: see a screenshot at=C2=A0https://www.typerex.org/= ocp-index.html#ocp-browser

--Fabrice

On Thu, Sep 29, 2016 at 5= :14 PM Anil Madhavapeddy <anil@recoil= .org> wrote:
Dear all,

I have deployed an experimental documentation build for MirageOS libraries = (and dependencies thereof) using odig at:

http= ://docs.mirage.io

an experimental build using odoc (the new cross-referencing tool that is st= ill being worked on, so expected rendering bugs) is available under:

http://docs.mirage.io/odoc/

These URLs are all subject to change, but I thought it might be useful to s= ee the generated output for a real project.=C2=A0 The Dockerfile that gener= ates this site is at: https://github.com/= mirage/mirage/blob/master/Dockerfile.doc

regards,
Anil

> On 27 Sep 2016, at 20:34, Daniel B=C3=BCnzli <daniel.buenzli@erratique.ch= > wrote:
>
> Hello,
>
> Due to concerns over a binary name clash with OpenWRT's package ma= nager [1], the opkg project
> was renamed to odig.
>
>=C2=A0 http://erratique.ch/software/odig
>
> If you have installed opkg the way out is:
>
> opkg cache clear
> opam remove opkg
> opam update && opam install odig
> odig ocamldoc
> odig doc
>
> Thanks to David Kaloper Mer=C5=A1injak and Peter Zotov for raising
> the issue.
>
> Sorry for the inconvenience and happy doc digging,
>
> Daniel
>
> P.S. To package devs if there are issues with the way your docs get re= ndered please get in touch on the issue tracker (if that's not due to y= our package install or an ocamldoc issue itself).
>
> [1] https://wiki.openwrt.org/doc/techref/opkg
>
> _______________________________________________
> MirageOS-devel mailing list
> MirageOS-devel@lists.xenproject.org
> https://lists.xenproject.or= g/cgi-bin/mailman/listinfo/mirageos-devel


--
Caml-list mailing list.=C2=A0 Subscription management and archives:
https://sympa.inria.fr/sympa/arc/caml-list
Beginner's list: http://groups.yahoo.com/group/ocam= l_beginners
Bug reports: http://caml.inria.fr/bin/caml-bugs
--001a114697e6308ff3053db5d595--