From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from scc-mailout-kit-02.scc.kit.edu (scc-mailout-kit-02.scc.kit.edu [129.13.231.82]) by mandoc.bsd.lv (OpenSMTPD) with ESMTP id a4cb41a0 for ; Thu, 13 Feb 2020 13:34:24 -0500 (EST) Received: from hekate.asta.kit.edu ([141.3.145.153] helo=hekate.usta.de) by scc-mailout-kit-02.scc.kit.edu with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (envelope-from ) id 1j2JJd-0005dP-R8; Thu, 13 Feb 2020 19:34:23 +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 1j2JJb-0006HM-Rq; Thu, 13 Feb 2020 19:34:19 +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 1j2JJb-0001cz-M1; Thu, 13 Feb 2020 19:34:19 +0100 Received: from localhost (athene.usta.de [local]) by athene.usta.de (OpenSMTPD) with ESMTPA id 230dc061; Thu, 13 Feb 2020 19:34:19 +0100 (CET) Date: Thu, 13 Feb 2020 19:34:19 +0100 From: Ingo Schwarze To: "Jason A. Donenfeld" Cc: Stephen Gregoratto , discuss@mandoc.bsd.lv, WireGuard mailing list Subject: Re: [PATCH] Fix formatting in wg-quick(8) Message-ID: <20200213183419.GF75465@athene.usta.de> References: <20200213042900.2ed2sbhglg5uzjq5@BlackBox> <20200213044921.8115-1-dev@sgregoratto.me> 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: User-Agent: Mutt/1.12.2 (2019-09-21) Hi Jason, Jason A. Donenfeld wrote on Thu, Feb 13, 2020 at 05:31:41PM +0100: > On Thu, Feb 13, 2020 at 5:50 AM Stephen Gregoratto wrote: >> +.TH WG-QUICK 8 "2019-02-13" ZX2C4 "WireGuard" > It's 2020 now, but what would you think of retaining the original > date? Or do you usually bump it on every change? I'm not sure what the > convention is. The .TH macro is supposed to contain the date of the last change. If you want to explain when something was first implemented, you can do that below ".SH HISTORY". >> +.PP >> +The following might be used for connecting as a client to a VPN gateway for >> +tunneling all traffic: >> +.nf >> +.sp >> +.RS 6n > Never seen these three modifiers. They set spacing somehow? Not sure what you mean by "modifiers". .nf and .sp are roff(7) requests, .RS is a man(7) macro, and 6n is a scaling width. https://man.openbsd.org/roff.7#nf https://man.openbsd.org/roff.7#sp https://man.openbsd.org/man.7#RS_2 https://man.openbsd.org/roff.7#Scaling_Widths >> .SH SEE ALSO >> -.BR wg (8), >> +.BR pass (1), >> .BR ip (8), >> -.BR ip-link (8), >> .BR ip-address (8), >> +.BR ip-link (8), >> .BR ip-route (8), >> .BR ip-rule (8), >> -.BR resolvconf (8). >> - >> +.BR iptables (8), >> +.BR resolvconf (8), >> +.BR wg (8) >> .SH AUTHOR >> .B wg-quick > You've ordered these alphabetically, but the original ordering was > chosen deliberately. Sorting first by section, then alphabetically is done by convention. For example, see this style guide: https://mandoc.bsd.lv/mdoc/style/see_also.html The reason is that the number of references ought to be small, so deliberate ordering adds little value, and a fixed ordering results in a more predictable experience for the reader. Yours, Ingo -- To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv