From mboxrd@z Thu Jan 1 00:00:00 1970 From: Olaf Hering Subject: Re: [PATCH 0/6] docs: convert manpages to pod Date: Mon, 24 Jul 2017 19:44:17 +0200 Message-ID: <20170724174416.GC8603@aepfle.de> References: <20170724141450.22971-1-olaf@aepfle.de> <22902.6431.562992.752359@mariner.uk.xensource.com> <20170724160916.GB8603@aepfle.de> <22902.8038.466272.858794@mariner.uk.xensource.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0457576997903638498==" Return-path: In-Reply-To: <22902.8038.466272.858794@mariner.uk.xensource.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" To: Ian Jackson Cc: Wei Liu , xen-devel@lists.xen.org List-Id: xen-devel@lists.xenproject.org --===============0457576997903638498== Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="2JFBq9zoW8cOFH7v" Content-Disposition: inline --2JFBq9zoW8cOFH7v Content-Type: text/plain; charset=utf-8 Content-Disposition: inline On Mon, Jul 24, Ian Jackson wrote: > * There are a lot of other documents in docs/misc/ which are in > markdown format. Some of them are internal. I'm pretty sure we don't > want them _all_ converted. So even if you convert the manpages, these > documents will remain. I did not intent to change other files outside of docs/man/. Just the references to non-existant manpages triggered this series. Sometimes I wish that xen-command-line.5 exists, but google always helped in such occasions. > * It may be that there are other markdown processors which could be > substituted for pandoc - either at runtime or by changing the Xen > Project's default, upstream. After a quick research there is a ruby "ronn" and go/ruby "md2man". Both would have the same dependency issue. Perhaps ruby is less troublesome because YaST is written in ruby. > * Our markdown documents are, I think, intended to be plain text which > can be simply shipped as-is. So for things other than manpages you > can probably just ship them as if they were text files. If the end > user wants to read them in a fancy format (eg HTML) they could install > the relevant processor. Yes. I have to see what HTML we ship. So far it did not cause trouble. > * I don't understand why promoting GHC would be a problem. But, in > the worst case, rather than demoting Xen, you could simply not ship > certain docs (although - see above about plain text). The package ghc is in the tree since nearly 5 years, pandoc since 3 years. The hurdle is likely that a 4GB DVD is filled quickly. It is always a fight to get everyone happy, and ghc is seen as leaf package. Olaf --2JFBq9zoW8cOFH7v Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iF0EARECAB0WIQSkRyP6Rn//f03pRUBdQqD6ppg2fgUCWXYx6wAKCRBdQqD6ppg2 fpU/AJ9KmwdUHSMsjPIYf/LQ+sRAcr2MmACgkscZiV8g2yqegUyhWSnNubywyJ0= =iYWF -----END PGP SIGNATURE----- --2JFBq9zoW8cOFH7v-- --===============0457576997903638498== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KWGVuLWRldmVs IG1haWxpbmcgbGlzdApYZW4tZGV2ZWxAbGlzdHMueGVuLm9yZwpodHRwczovL2xpc3RzLnhlbi5v cmcveGVuLWRldmVsCg== --===============0457576997903638498==--