Bug#902555: radeon.4: Some fixes in the manual

G. Branden Robinson g.branden.robinson at gmail.com
Thu Jun 28 13:58:27 UTC 2018

At 2018-06-28T11:31:30+0200, Michel Dänzer wrote:
> Please send this kind of change directly upstream to the
> amd-gfx at lists.freedesktop.org list for review, split up into one patch
> per logical change.

Well, a lot of these changes aren't "logical", they're stylistic.

> On 2018-06-27 09:07 PM, Bjarni Ingi Gislason wrote:
> > 
> > Don't begin a sentence with a digit.
> Why not? What's the problem with that?

It's considered substandard English style.

See, e.g., [1]


The Chicago Manual of Style, which is the preferred style guide of
Michael Kerrisk of the Linux Man-Pages Project, is paywalled[2], but my
copy of the 14th edition says:

§8.9 "At the beginning of a sentence any number that would ordinarily be
set in numerals is spelled out, regardless of any inconsistency this may
create [...]".

Other style guides broadly agree, though they might not be quite as
militant about it as Chicago is.

> > Add a comma after "e.g.".
> That looks odd to me.

It's standard to have the comma.

Chicago, 14th ed. again:

§5.62 "A comma is usually used after such expressions as _that is_,
_namely_, _i.e._, and _e.g._  The punctuation preceding such expressions
should be determined by the magnitude of the break in continuity.  If
the break is minor, a comma should be used.  If the break is greater
than that signaled by a comma, a semicolon or an em dash may be used, or
the expression and the element it introduces may be enclosed in
parentheses". [italics replaced by underscore delimeters]

I've run into Bjarni in the groff and man-pages projects.  He's a
detail-oriented style maven after my own heart and I can vouch that his
proposed corrections are usually sound ones.

[1] ;-)
[2] >:( http://www.chicagomanualofstyle.org/16/ch06/ch06_toc.html
redirects me to a login screen.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://lists.x.org/archives/xorg-driver-ati/attachments/20180628/70f2058f/attachment.sig>

More information about the xorg-driver-ati mailing list