This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: Consensus on MT-, AS- and AC-Safety docs.
- From: "Joseph S. Myers" <joseph at codesourcery dot com>
- To: Alexandre Oliva <aoliva at redhat dot com>
- Cc: Torvald Riegel <triegel at redhat dot com>, Carlos O'Donell <carlos at redhat dot com>, GNU C Library <libc-alpha at sourceware dot org>, Rich Felker <dalias at aerifal dot cx>
- Date: Mon, 25 Nov 2013 18:04:55 +0000
- Subject: Re: Consensus on MT-, AS- and AC-Safety docs.
- Authentication-results: sourceware.org; auth=none
- References: <528A7C8F dot 8060805 at redhat dot com> <Pine dot LNX dot 4 dot 64 dot 1311182312130 dot 8831 at digraph dot polyomino dot org dot uk> <orob5fv8nl dot fsf at livre dot home> <Pine dot LNX dot 4 dot 64 dot 1311201555320 dot 28804 at digraph dot polyomino dot org dot uk> <orli0itbm5 dot fsf at livre dot home> <Pine dot LNX dot 4 dot 64 dot 1311211322040 dot 14539 at digraph dot polyomino dot org dot uk> <or4n75t4b7 dot fsf at livre dot home> <Pine dot LNX dot 4 dot 64 dot 1311221324200 dot 5029 at digraph dot polyomino dot org dot uk> <orob5csdvx dot fsf at livre dot home> <Pine dot LNX dot 4 dot 64 dot 1311221535560 dot 8443 at digraph dot polyomino dot org dot uk> <or61rjs2li dot fsf at livre dot home> <orhab3qktz dot fsf at livre dot home>
On Sat, 23 Nov 2013, Alexandre Oliva wrote:
> There's a linguistics argument to be made here.
I think the linguistics can go just as much the other way - people read
text in much larger blocks than individual letters or syllables, and so
code-words that aren't made of normal English words or conventional
abbreviations in meaningful sequence, properly separated rather than run
together, seriously disrupt readability and are quite likely to be
ignored, or treated as spelling errors ("incansist" suggests "the writer
doesn't know how to spell 'inconsistent'" more than it suggests "this is a
technical term with a special glibc-local definition").
> Someone who's reading the manual is there to learn something; they're
> learning not just definitions, but a language. After all, cryptic
They're learning the use of glibc functions, not glibc-specific code words
which will never be of use for anything other than reading the glibc
manual. (If there is a standard computer science term for some particular
issue, not specific to glibc, of course use that term; that's a case where
there is more use to a reader learning the meaning of some specialist
language.)
> *expect* to and *want* to deal with that; they're reading the manual
> precisely because they want to learn what those new words mean.
No, they want to learn how to use glibc functions. Words that are not
part of how to use the functions (e.g. constants defined in a header that
are arguments to a function) are a distraction.
--
Joseph S. Myers
joseph@codesourcery.com
- References:
- Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.
- Re: Consensus on MT-, AS- and AC-Safety docs.