From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-1.0 required=5.0 tests=MAILING_LIST_MULTI autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 6445 invoked from network); 9 Sep 2020 08:19:27 -0000 Received: from alyss.skarnet.org (95.142.172.232) by inbox.vuxu.org with ESMTPUTF8; 9 Sep 2020 08:19:27 -0000 Received: (qmail 17283 invoked by uid 89); 9 Sep 2020 08:19:50 -0000 Mailing-List: contact supervision-help@list.skarnet.org; run by ezmlm Sender: Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Received: (qmail 17276 invoked from network); 9 Sep 2020 08:19:50 -0000 From: "Laurent Bercot" To: supervision@list.skarnet.org Subject: Re: s6-man-pages update Date: Wed, 09 Sep 2020 08:19:23 +0000 Message-Id: In-Reply-To: <875z8nd1y5.fsf@ada> References: <875z8nd1y5.fsf@ada> Reply-To: "Laurent Bercot" User-Agent: eM_Client/8.0.3385.0 Mime-Version: 1.0 Content-Type: text/plain; format=flowed; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-VR-SPAMSTATE: OK X-VR-SPAMSCORE: 0 X-VR-SPAMCAUSE: gggruggvucftvghtrhhoucdtuddrgeduiedrudehgedgudefudcutefuodetggdotffvucfrrhhofhhilhgvmecupfgfoffgtffkveetuefngfdpqfgfvfenuceurghilhhouhhtmecufedttdenucenucfjughrpefhvffufffkjghfrhgfgggtgfesthhqredttderjeenucfhrhhomhepfdfnrghurhgvnhhtuceuvghrtghothdfuceoshhkrgdqshhuphgvrhhvihhsihhonhesshhkrghrnhgvthdrohhrgheqnecuggftrfgrthhtvghrnhepfeehvdfgjeeuffeuueeluddtudetjedtfeefgefhjeevvdehuefghfetgedtuefhnecuffhomhgrihhnpehgihhthhhusgdrtghomhdpshhkrghrnhgvthdrohhrghdpnhhonhdqshhkrghrnhgvthdrohhrghenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhhouggvpehsmhhtphhouhht >i've now completed the linting pass for the s6 man pages. The few remainin= g lint issues are either commented in the sources, or aren't actually an is= sue in this context. > >As per Laurent's request, i've also added a Makefile to facilitate install= ation; details in the repo README: > >https://github.com/flexibeast/s6-man-pages/ Nice work! If you feel they're ready enough, I can add a link to them in the s6 main page right away. Two comments: - The skarnet.org site is accessible in https, and is preferred. Intra-site links have no default protocol, so they will link in http if the client uses http, and in https if the client uses https; but for absolute URLS, it would probably be best to write them as https. - You should list yourself in the AUTHORS section: I wrote the content, but you wrote the man pages. >* links to other skarnet.org documentation which does not yet have man pa= ges: s6-networking (s6-tcpserver-access, s6-tcpserver, s6-tcpserver4, s6-t= cpserver6), execline (execline and execlineb, maybe others as well?), and= skalibs stuff. For an example of a page referring to s6-networking softwar= e, cf. s6-connlimit.1.in. If that documentation was available as man page= s, these could just be made cross-references too. I don't want to be making suggestions on work I'm not going to do myself and that I have no deep understanding of; but is there a way to have an alternative in .Xr, as in "print as a cross-ref if the man page exists, else print that text"? That would be ideal for placeholders until the documentation for other packages is ported (which may very well be "never"). >* links to non-skarnet.org sites, such as djb's site. These certainly see= m amenable to use of the footnoting style you described above. Yes, I don't think it's reasonable to expect the whole Web to be converted to man pages. ;) -- Laurent