[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#824908: apt: inconsistent “header” terminology throughout documentation, comments, messages



On 21-May-2016, David Kalnischkies wrote:

> Could you please split especially the first one up more?

I have now updated the branch with more granular changes
<URL:https://notabug.org/bignose/debian_apt/commits/wip/issue/824908/terminology-header-fields>.

> As an example, your changes in the context of gpgv are incorrect as
> the official term in rfc2440 for the "key-value pairs" is "Armor
> Header" not field as you suggest and even if that is grossly
> inconsistent I don't think its a good idea to change this.

The documentation refers to the “armor header” as the collection of
name-value pairs that head the armor. I have now followed this
terminology.

> In the context of http(-like) the more correct term might be "header
> fields" which you use sometimes (then you replaced a 'line'), but
> not always. In comments just "fields" might be correct much like the
> RFC uses it in long paragraphs where its clear what is meant, but in
> error messages we should perhaps be using the full term.

I have tried to make minimal changes to the text of messages. For many
context there is no other kind of field, so “field” suffices in most
places.

> (btw: the registry for "Message Header Field Names" is called
> "Message Headers", so using "headers" isn't as inconsistent as you
> make it sound)

If that name is used, it's another inconsistency :-)

> Changing the tests/integration/status-* files is interesting in so
> far as you are modifying the descriptions of actual packages (which
> might or might not be changed in the meantime).

Do those packages actually exist? I didn't realise.

Will the corrected text alter the outcome of the test case?

> Changing to "LSB fields" is in sofar interesting as even the
> "official doc" [0] isn't clear on which term is preferred.

Yes. I have made note of this in the separate revision now committed.

> In the documentation you do typo/style fixes (FDs, URIs, HTTP, …)
> which should be fixed in the translations (doc/po) as well to avoid
> needless fuzzies.

I am not sure how to do this (I am not familiar with proper use of
gettext). I only changed terms in the area where I was already
changing “header” and “field” terminology.

Which files should I modify for translation? Some are auto-generated,
I think.

> Some of the http->HTTP changes are wrong as these parts are talking
> about the method named 'http', not the protocol 'HTTP'.

Right, I have taken more care and distinguished ‘http’ as a method
name now.


Please (someone) review the latest update when you have time, and let
me know what should be done to get the changes in.

-- 
 \     “The aim of science is not to open the door to infinite wisdom, |
  `\        but to set some limit on infinite error.” —Bertolt Brecht, |
_o__)                                        _Leben des Galilei_, 1938 |
Ben Finney <ben@benfinney.id.au>

Attachment: signature.asc
Description: PGP signature


Reply to: