From owner-freebsd-ports@freebsd.org Thu Sep 17 11:55:10 2020 Return-Path: Delivered-To: freebsd-ports@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id CC4593DD3F6 for ; Thu, 17 Sep 2020 11:55:10 +0000 (UTC) (envelope-from freebsd@grem.de) Received: from mail.evolve.de (mail.evolve.de [213.239.217.29]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (Client CN "mail.evolve.de", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Bsb4Z0VJSz3cdy; Thu, 17 Sep 2020 11:55:09 +0000 (UTC) (envelope-from freebsd@grem.de) Received: by mail.evolve.de (OpenSMTPD) with ESMTP id 4c3f24d8; Thu, 17 Sep 2020 11:55:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=grem.de; h=date:from:to:cc :subject:message-id:in-reply-to:references:mime-version :content-type:content-transfer-encoding; s=20180501; bh=k/iQn2HM k0NGGJKZeJeSiGfTvU8=; b=PjfpzVY8qatKD+MttDOGwSE/yT8/UiiWpzXplrE2 J4DWkGd8/mNxnLhir1e9AUbu+IA2fiGgnNssWQQhPZGnYj/hzqzMDUvq1/qPw8jt o9MLozTSpH4S7OGEpvm6aPmL/Hw3mMjVQXfYH9zh8Li8+Yrf/vAPvvWDiXOnx1dX i9G7nHoc1Eep5zM4qzVkxxOK0Dv9YBKVicTmh9f0pr1V+abru8VgWrndx8fcu7Y8 rQzxB7gisGqqCO15n4zX20SvfMZ6I0qxM/cxVGecSnvgTbRLE3bIrBu729AZRXN3 X60hYHDNClzaMNM5uYBhlckI29ltebeKs0cJSdCe/UmEcw== DomainKey-Signature: a=rsa-sha1; c=nofws; d=grem.de; h=date:from:to:cc :subject:message-id:in-reply-to:references:mime-version :content-type:content-transfer-encoding; q=dns; s=20180501; b=vQ zy8GXG/p/Q/oXfo2O6DzU60B9Adzg+GvkdrfELm4BLGHdCZDlzM83ZjTipaeViQ3 44G6TQ1wfuHliHGheWv19EXvuhuL8ZgmyS6b5k65A1xFwHLYQ2FXrtEB9p3qxBR7 cqelt9EzGuZYL2W3Ajmaah5a9R2keSlz9Fun0R6enAoducfESzcxg+RW0L5VIju+ MNV2HtELwNzmJllaz3D8Kg4JHA0m7tOK/oR5TVHcnRyfzrSF5Owci7DFC7gjg7ZX WTaJl47Dv9B1pGxiE/SCo6txBdppsm9jJvgt7s+ru+toM5AUrOdG4+ODdcisPaD4 tlf8v5jCksa2sH6TFrwg== Received: by mail.evolve.de (OpenSMTPD) with ESMTPSA id 11bea8c5 (TLSv1.2:ECDHE-RSA-CHACHA20-POLY1305:256:NO); Thu, 17 Sep 2020 11:55:03 +0000 (UTC) Date: Thu, 17 Sep 2020 13:54:59 +0200 From: Michael Gmelin To: Wolfram Schneider Cc: Kurt Jaeger , "freebsd-ports@freebsd.org" Subject: Re: How do port man pages get into https://www.freebsd.org/cgi/man.cgi? Message-ID: <18642207-FA26-47F6-9F2E-9ABCA9306240@grem.de> In-Reply-To: References: X-Face: $wrgCtfdVw_H9WAY?S&9+/F"!41z'L$uo*WzT8miX?kZ~W~Lr5W7v?j0Sde\mwB&/ypo^}> +a'4xMc^^KroE~+v^&^#[B">soBo1y6(TW6#UZiC]o>C6`ej+i Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAAJFBMVEWJBwe5BQDl LASZU0/LTEWEfHbyj0Txi32+sKrp1Mv944X8/fm1rS+cAAAACXBIWXMAAAsTAAAL EwEAmpwYAAAAB3RJTUUH3wESCxwC7OBhbgAAACFpVFh0Q29tbWVudAAAAAAAQ3Jl YXRlZCB3aXRoIFRoZSBHSU1QbbCXAAAAAghJREFUOMu11DFvEzEUAGCfEhBVFzuq AKkLd0O6VrIQsLXVSZXoWE5N1K3DobBBA9fQpRWc8OkWouaIjedWKiyREOKs+3PY fvalCNjgLVHeF7/3bMtBzV8C/VsQ8tecEgCcDgrzjekwKZ7TwsJZd/ywEKwwP+ZM 8P3drTsAwWn2mpWuDDuYiK1bFs6De0KUUFw0tWxm+D4AIhuuvZqtyWYeO7jQ4Aea 7jUqI+ixhQoHex4WshEvSXdood7stlv4oSuFOC4tqGcr0NjEqXgV4mMJO38nld4+ xKNxRDon7khyKVqY7YR4d+Cg0OMrkWXZOM7YDkEfKiilCn1qYv4mighZiynuHHOA Wq9QJq+BIES7lMFUtcikMnkDGHUoncA+uHgrP0ctIEqfwLHzeSo+eUA66AqzwN6n 2ZHJhw6Qh/PoyC/QENyEyC/AyNjq74Bs+3UH0xYwzDUC4B97HgLocg1QLYgDDO1v f3UX9Y307Ew4AHh67YAFFsxEpkXwpXY3eIgMhAAE3R19L919nNnuD2wlPcDE3UeT L2ytEICQib9BXgS2fU8PrD82ToYO1OEmMSnYTjSqSv9wdC0tPYC+rQRQD9ESnldF CyqfmiYW+tlALt8gH2xrMdC/youbjzPXEun+/ReXsMCDyve3dZc09fn2Oas8oXGc Jj6/fOeK5UmSMPmf/jL+GD8BEj0k/Fn6IO4AAAAASUVORK5CYII= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Rspamd-Queue-Id: 4Bsb4Z0VJSz3cdy X-Spamd-Bar: ---- Authentication-Results: mx1.freebsd.org; none X-Spamd-Result: default: False [-4.00 / 15.00]; REPLY(-4.00)[]; ASN(0.00)[asn:24940, ipnet:213.239.192.0/18, country:DE] X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.33 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 17 Sep 2020 11:55:10 -0000 Hi Wolfram, > On 17. Sep 2020, at 11:44, Wolfram Schneider > wrote: >=20 > =EF=BB=BFOn Wed, 16 Sep 2020 at 20:34, Michael Gmelin w= rote: >>=20 >> @Wolfram: Do you think you could look into this (paperless man >> page). Thanks! >=20 > the page https://man.freebsd.org/paperless >=20 > looks fine for me. What are you missing? >=20 When I checked yesterday, it just returned an empty page (I only tried once though). Today it shows up, but it has some serious[0] rendering issues (starting at about "Install and configure uwsgi"), which are probably caused by misinterpreting '\\"' at the end of line 135 of the man page. It renders fine using man(1) on the console (which uses mandoc(1)) and also when converting it to html using `mandoc -T html'. `mandoc -T lint' is also happy with the man page. `groff -T html -man' does complain though, shows these issues at line 135: :135: a space character is not allowed in an escape name :135: warning: numeric expression expected (got `u') :135: warning: can't find font `[' and creates output like the one seen on man.freebsd.org. Based on this, I assume that man.cgi uses groff or a similar tool and not mandoc to create html output. I'll change literal parts of the paperless man page later today, so that examples render nicer using `mandoc -T html', which will also fix groff output as a side-effect by getting rid of the offending escape sequence. I'll bump the revision and hope that it will be picked up sooner or later. Since we switched to mandoc(1) being the default for man(1) in HEAD more than five years ago, I think it would make sense to do the same for man.cgi to keep things consistent. QA is usually done using mandoc -T lint for syntax, igor for style, and by checking manually on the console, none of which would have revealed that problem (not just for ports, but also in base). Adapting the style sheet shouldn't be too hard. I'm happy to help with that, if needed. Thanks Michael [0]Serious in the sense that relevant information is lost. > -Wolfram >=20 >=20 >> -m >>=20 >>>> On 1. Sep 2020, at 11:55, Michael Gmelin wrote: >>>=20 >>> =EF=BB=BF >>>=20 >>>> On Mon, 31 Aug 2020 20:33:34 +0200 >>>> Wolfram Schneider wrote: >>>>=20 >>>>> On Wed, 26 Aug 2020 at 18:50, Kurt Jaeger wrote: >>>>>=20 >>>>> Hi! >>>>>=20 >>>>>>> man.cgi has provisions for most of this already, it's only >>>>>>> missing some job to regulary extract the latest >>>>>>>=20 >>>>>>> ftp://ftp.freebsd.org/pub/FreeBSD/snapshots/amd64/13.0-CURRENT/port= s.txz >>>>>>>=20 >>>>>>> for the current tree of the manuals. >>>>>>=20 >>>>>> How does it actually create the pages though? >>>>>=20 >>>>> wosch probably knows this. >>>>=20 >>>> Indeed ;-) >>>=20 >>> Thanks! >>>=20 >>>>=20 >>>> The ports manual pages will be updated once when a new release >>>> comes out. Maybe every 3-9 months. The update takes hours and a >>>> lot of resources (60GB download of all packages and unpacking). >>>>=20 >>>=20 >>> It would be cool if you could share the scriptwork that does this. >>> Getting to a higher update frequency for ports would be really >>> useful, but it feels like that this will require coordination >>> between different teams/individuals. >>>=20 >>>> -Wolfram >>>=20 >>> Do you have any idea why the man page below isn't included? >>>=20 >>>>>> E.g., the >>>>>> man page paperless(7) created by deskutils/py-paperless [0] still >>>>>> isn't available over man.cgi, even though the port was created a >>>>>> long time before 12.1 was released and is in 12.1's ports.txz. >>>=20 >>> Cheers, >>> Michael >>>=20 >>> -- >>> Michael Gmelin >>> _______________________________________________ >>> freebsd-ports@freebsd.org mailing list >>> https://lists.freebsd.org/mailman/listinfo/freebsd-ports >>> To unsubscribe, send any mail to >>> "freebsd-ports-unsubscribe@freebsd.org" >>=20 >=20 >=20 > --=20 > Wolfram Schneider https://wolfram.schneider.org