From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from scc-mailout-kit-01.scc.kit.edu (scc-mailout-kit-01.scc.kit.edu [129.13.231.81]) by mandoc.bsd.lv (OpenSMTPD) with ESMTP id d405d263 for ; Fri, 14 Feb 2020 13:20:53 -0500 (EST) Received: from hekate.asta.kit.edu ([141.3.145.153] helo=hekate.usta.de) by scc-mailout-kit-01.scc.kit.edu with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (envelope-from ) id 1j2fa6-0004u4-UL; Fri, 14 Feb 2020 19:20:52 +0100 Received: from donnerwolke.asta.kit.edu ([141.3.145.61] helo=donnerwolke.usta.de) by hekate.usta.de with esmtp (Exim 4.92.2) (envelope-from ) id 1j2fa4-0002Ok-TM; Fri, 14 Feb 2020 19:20:48 +0100 Received: from athene.asta.kit.edu ([141.3.145.60] helo=athene.usta.de) by donnerwolke.usta.de with esmtp (Exim 4.84_2) (envelope-from ) id 1j2fa4-0007lg-NR; Fri, 14 Feb 2020 19:20:48 +0100 Received: from localhost (athene.usta.de [local]) by athene.usta.de (OpenSMTPD) with ESMTPA id 5cf9e18f; Fri, 14 Feb 2020 19:20:48 +0100 (CET) Date: Fri, 14 Feb 2020 19:20:48 +0100 From: Ingo Schwarze To: "Anthony J. Bentley" Cc: discuss@mandoc.bsd.lv, "Jason A. Donenfeld" , Stephen Gregoratto Subject: Re: [PATCH] Fix formatting in wg-quick(8) Message-ID: <20200214182048.GH92189@athene.usta.de> References: <20200213042900.2ed2sbhglg5uzjq5@BlackBox> <20200213044921.8115-1-dev@sgregoratto.me> <20200213175735.GE75465@athene.usta.de> <20200213193430.GG75465@athene.usta.de> <20200213222845.GA31578@athene.usta.de> <26710-1581652819.729791@VYCU.Vgnw.Vr5M> X-Mailinglist: mandoc-discuss Reply-To: discuss@mandoc.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <26710-1581652819.729791@VYCU.Vgnw.Vr5M> User-Agent: Mutt/1.12.2 (2019-09-21) Hi Anthony, Anthony J. Bentley wrote on Thu, Feb 13, 2020 at 09:00:19PM -0700: > My attempt is below. Thanks! > - There were a few places like this where I wasn't sure if squeezing Ar > in there might be overkill: > > Upon bringing the interface up, this runs > .Ql resolvconf -a tun.INTERFACE -m 0 -x > and upon bringing it down, this runs > .Ql resolvconf -d tun.INTERFACE . Right, these are somewhat ugly. Long in-line code examples tend to look ugly in general, but where they can't be avoided, .Ql is the right macro to use. This can hardly be improved without rewording the text, which you rightly avoided during the conversion. It is technically possible to use .Ar inside .Ql, but i'd say it is better avoided. > - Does the config file support statements across multiple lines (with > backslash or some such)? Then we could avoid the ugly wrapping in > wg-quick(8)'s EXAMPLES. > > - Wasn't there discussion on the Groff list about moving to title case > instead of all caps in section headers? Is that something we want to > encourage in downstream manuals? Not yet, maybe in the future. Groff now supports the new way. Support in mandoc is still pending. Before advertising it widely, we should make a decision for OpenBSD base. > - Not sure of my use of Bro/Brc. Usually, such braces are not needed, we almost never use them in OpenBSD base. Then again, you didn't want to change the wording or the punctuation, and retaining them isn't wrong. If you want curlies here, then .Bro is the right macro. > - The hanging indent in long tag list items seems problematic here. > Suggestions? As any other details, that can be polished after commit. Ultimately, i would probably recommend something like .It Ic set Ar interface Op Ar options Set configuration values for the specified .Ar interface . .Pp The options are as follows: .Bl -tag -width Ds .It Cm fwmark Ar fwmark The 32-bit [replace jargon word by an actual description] for outgoing packets, either as a decimal integer or as a hexadecimal integer starting with .Ql 0x . The default is 0 [which disables the feature; or even better, say more precisely what it means when this feature is "off"]. The special value .Cm off is an alias for 0 [or even better, deprecate the duplication in the user interface and stop documenting it]. .It Cm listen-port Ar port [A description is missing here what it means.] The default is 0, which causes a port to be chosen randomly when the interface comes up. .It [...] and so one. Usually, tagged lists are more readable than long paragraphs of prose with keywords scattered in the middle. Yes, i do think the page still needs some work after this initial conversion, also regarding the content, but that is better done in multiple steps, each patch focussed on one aspect, with careful review of each patch. Yours, Ingo -- To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv