Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Tue, 22 Sep 2020 00:36:19 +1000
From:   "G. Branden Robinson" <g.branden.robinson@gmail.com>
To:     "mtk.manpages@gmail.com" <mtk.manpages@gmail.com>,
        "linux-man@vger.kernel.org" <linux-man@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 22/24] membarrier.2: Note that glibc does not provide a
 wrapper
Message-ID: <20200921143617.2iskdncu3diginqn@localhost.localdomain>
References: <20200910211344.3562-1-colomar.6.4.3@gmail.com>
 <20200910211344.3562-23-colomar.6.4.3@gmail.com>
 <4ace434523f5491b9efcc7af175ad781@bfs.de>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="gn4pjnbkmrfvlsqv"
Content-Disposition: inline
In-Reply-To: <4ace434523f5491b9efcc7af175ad781@bfs.de>
User-Agent: NeoMutt/20180716
Precedence: bulk


--gn4pjnbkmrfvlsqv
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

At 2020-09-11T12:58:08+0000, Walter Harms wrote:
> the groff commands are ducument in man 7 groff
> .nf       No filling or adjusting of output-lines.
> .fi       Fill output lines
>=20
> (for me) a typical use is like this:
> .nf
>=20
> struct timeval {
>     time_t      tv_sec;     /* seconds */
>     suseconds_t tv_usec;    /* microseconds */
> };
> .fi
>=20
> In the top section you prevent indenting (if any).

The above will not work as desired for typesetter output, a.k.a., "troff
devices", such as PostScript or PDF.  The initial code indent might work
okay but the alignment of the field names will become
ragged/mis-registered and the comments even more so.

This is because a proportional font is used by default for troff
devices.  The classical man macros, going back to Version 7 Unix (1979)
had no good solution for this problem and Unix room tradition at Murray
Hill going all the way back to (what we now call) the First Edition
manual in 1971 was to read the man pages on a typewriter--a Teletype
Model 33 or Model 37.  Typewriters, of course, always[1] used monospaced
fonts.

Version 9 Unix (1986) introduced .EX and .EE for setting material in a
monospaced font even if the device used proportional type by default.
(Plan 9 troff inherited them.)  GNU roff has supporteds .EX and .EE as
well, for over 13 years, and its implementations are ultra-permissively
licensed so other *roffs like Heirloom Doctools have picked them up.
Therefore I recommend .EX and .EE for all code examples.

They are very simple to use.  In the above, simply replace ".nf" with
".EX" and ".fi" with ".EE".

Regards,
Branden

[1] Not completely true; variable-pitch typewriters (such as 10/12 point
selectable) were fairly common and some expensive models like the IBM
Executive even featured true proportional type.

--gn4pjnbkmrfvlsqv
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEh3PWHWjjDgcrENwa0Z6cfXEmbc4FAl9oulAACgkQ0Z6cfXEm
bc4nXg//a/pFLV+dC2pLWh48NQsSaQaYU0IMPK0FpdGYloetyPw2bo75WGukzVPQ
GJ5yzvvQmI812qMmVnbChOZAr31EiaJqAqynG5XtmYxGIDK5Tx9cfnk+11Ko8DPQ
orUaPEb5/u7rhtiQgOoYAYVewrF2ooTGEGRKIeRBhHRJHm3Fm2VRduDt5ZOJ1JsO
aIdOc16tHBeAPJUjMamyVcSIoWZsWCdhdA4l9h94MeSrYYtZc3duDaieT9YnoZpx
FKeKvmfR7fWBF8ZlIXSemYume2/wtC9x5SGoWz9EFlQVBM0rrUwjPtgdbri4Y/kr
iBxiLcEJ350pPXGII4mMl/HWCfivFJRk9hd7tUGRvRXrj7MB4qQy5Myu993G+5X2
LbF1lg3lvEv4zlaC1+Vx7ljnA5guGYqxq9v977VucyEWicSml5NczuzuBpgl8ynJ
tJsFs04GBbR+8NHlILly2LOaI/B/9aFhUMYq1ix8GRqJABXhYA050t9n4UmlYIjA
hulieVMLHDCVf9u+0+dE5ript5Ggqmh880AYZLYXQR0jEcGelJDYoxM0ushMogCx
fFiO7iJpg/dr8l981Xe6B5t6xLKxzi9WJuZJ89V4efEjh/SK2SohGvYtRepzhj3a
VRKZf+9Qamwt2PYrd5hgdryqsEpIs8335KQxpfUKYdzn4scuRsI=
=i8QU
-----END PGP SIGNATURE-----

--gn4pjnbkmrfvlsqv--