• Re: Hard to read new paragraph in man page deb-origin

    From Guillem Jover@21:1/5 to Helge Kreutzmann on Sat Oct 8 18:50:02 2022
    Hi!

    On Sat, 2022-10-08 at 18:14:38 +0200, Helge Kreutzmann wrote:
    while updating the German man page translation I could not really
    understand one paragraph, could you explain it more verbosely?

    Hmm, then that probably means the English text needs to be rewritten
    or improved. Ok let me try first to explain here somewhat, and then I
    can try to update the man page:

    "The file should be named according to the vendor name. The usual convention "
    "is to name the vendor file using the vendor name in all lowercase, but some "
    "variation is permitted. Namely, non-alphanumeric characters (‘B<[^A-Za-" "z0-9]>’) are mapped to dashes (‘B<->’),

    and lower-cased, as-is, lower-cased "
    "then capitalized and capitalized (since dpkg 1.21.10).

    This means that the code will try the following combinations, after
    having remapped the non-alphanum chars:

    lower-cased: aA-bB%Some OS → aa-bb-some-os
    as-is: aA-bB%Some OS → aA-bB-Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb-some-os
    capitalized: aA-bB%Some OS → AA-bB-Some-OS

    In addition, for "
    "historical and backwards compatibility, the above casing attempts will be " "tried first as-is with no remapping, and then by remapping spaces to dashes "
    "(‘B<->’). But these will be removed during the dpkg 1.22.x release cycle."

    This means they will be tried then first w/o remapping as follows:

    lower-cased: aA-bB%Some OS → aa-bb%some os
    as-is: aA-bB%Some OS → aA-bB%Some OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some os
    capitalized: aA-bB%Some OS → AA-bB%Some OS

    And subsequently by only remapping spaces to dashes:

    lower-cased: aA-bB%Some OS → aa-bb%some-os
    as-is: aA-bB%Some OS → aA-bB%Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some-os
    capitalized: aA-bB%Some OS → AA-bB%Some-OS

    Was the problem with just the "as-is" or how the formulation of casing
    is listed?

    Thanks,
    Guillem

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Helge Kreutzmann@21:1/5 to All on Sat Oct 8 18:20:02 2022
    This is a MIME-formatted message. If you see this text it means that your E-mail software does not support MIME-formatted messages.

    Hello Guillem,
    while updating the German man page translation I could not really
    understand one paragraph, could you explain it more verbosely?

    "The file should be named according to the vendor name. The usual convention " "is to name the vendor file using the vendor name in all lowercase, but some " "variation is permitted. Namely, non-alphanumeric characters (‘B<[^A-Za-" "z0-9]>’) are mapped to dashes (‘B<->’), and lower-cased, as-is, lower-cased "
    "then capitalized and capitalized (since dpkg 1.21.10). In addition, for " "historical and backwards compatibility, the above casing attempts will be " "tried first as-is with no remapping, and then by remapping spaces to dashes " "(‘B<->’). But these will be removed during the dpkg 1.22.x release cycle."

    I'm fine until:
    … mapped to dashes (‘B<->’)

    Then we have string of alphanumeric characters and dashes. What
    exactly happens to this string? Could you give an example, e.g. how to transform the (fictious) string
    aA-bB

    This includes the wording "as is" because either you keep a character
    "as is" or you transform it, e.g. by changing the capitalization(?)

    Thanks for any explanation!

    Greetings

    Helge

    --
    Dr. Helge Kreutzmann debian@helgefjell.de
    Dipl.-Phys. http://www.helgefjell.de/debian.php
    64bit GNU powered gpg signed mail preferred
    Help keep free software "libre": http://www.ffii.de/

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

    iQIzBAABCAAdFiEEbZZfteMW0gNUynuwQbqlJmgq5nAFAmNBoeUACgkQQbqlJmgq 5nAndA//ayyRtSv7btJw2TqKELhpFMNlKWBUAjTYOMcueVskRjGWmcYQ4OO9reVM WzZ9hKhrpd3ViFitgDDWZHFi1i/tDFNAgv5TfEJ5zOyrWZMLVNH2zGk6vTScIN/k wEdKJTjv0py7jZTViQ5OfRPEIURhp9aF2fdG+rmucqvzEv040qUccN3QwCcL5ph0 r1rCkHuCzcSYcBOJJYPDuMO9ii2TOE+nsyv/TW/hmQbXP5w/B10E6VUdNjiVQ2Rk fX2dytOTa0OkB18A6HPX2iZGb0m76OU3bLxy314MYNtRnFsEjteQmm+nGarjg6YZ ZfFkN7I5rqUfSVMoVaw/7o7sOz4w9kKfdKmz45yIydgtXdsSm2iszIb54+hEXy39 Qxjvw220hnYUB6rcmWTUtMJT3zuTLgTvqoTY9Q7/POiImKvnw6xnhD9AFyRRGvVv ziv8xQjFP7uEJpD0h79TdsnUd490afbaGiQxhm6rAz7swP0EdYhXYznnY40X/xC7 dWP2BlwxwfbuLfDjQFT+1wq97JgJJPFzxcvtD7yEKuxpV1dx6SkercB1VAHetDiM FuqZgRU2Dr7OwLJbv+lYwpGxF+hLTlqN3GSe+tA
  • From Helge Kreutzmann@21:1/5 to Guillem Jover on Sat Oct 8 19:10:01 2022
    This is a MIME-formatted message. If you see this text it means that your E-mail software does not support MIME-formatted messages.

    Hello Guillem,
    On Sat, Oct 08, 2022 at 06:42:46PM +0200, Guillem Jover wrote:
    Hi!

    On Sat, 2022-10-08 at 18:14:38 +0200, Helge Kreutzmann wrote:
    while updating the German man page translation I could not really understand one paragraph, could you explain it more verbosely?

    Hmm, then that probably means the English text needs to be rewritten
    or improved. Ok let me try first to explain here somewhat, and then I
    can try to update the man page:

    "The file should be named according to the vendor name. The usual convention "
    "is to name the vendor file using the vendor name in all lowercase, but some "
    "variation is permitted. Namely, non-alphanumeric characters (‘B<[^A-Za-"
    "z0-9]>’) are mapped to dashes (‘B<->’),

    and lower-cased, as-is, lower-cased "
    "then capitalized and capitalized (since dpkg 1.21.10).

    This means that the code will try the following combinations, after
    having remapped the non-alphanum chars:

    lower-cased: aA-bB%Some OS → aa-bb-some-os
    as-is: aA-bB%Some OS → aA-bB-Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb-some-os
    capitalized: aA-bB%Some OS → AA-bB-Some-OS

    Ok, so I understand the 2nd sentence as follows (I write it verbose):
    Namely, the following variations are accepted as well:
    a) non-alphanumeric characters (‘B<[^A-Za-z0-9]>’) in the vendor name
    are mapped to dashes (‘B<->’) and all letters are lower-cased
    b) the vendor name is kept as it is
    c) all letters in the vendor name are lower cased and then first letter
    is capitalized
    d) all letters (?) in the vendor name are capitalized
    (since dpkg 1.21.10).

    In addition, for "
    "historical and backwards compatibility, the above casing attempts will be "
    "tried first as-is with no remapping, and then by remapping spaces to dashes "
    "(‘B<->’). But these will be removed during the dpkg 1.22.x release cycle."

    This means they will be tried then first w/o remapping as follows:

    lower-cased: aA-bB%Some OS → aa-bb%some os
    as-is: aA-bB%Some OS → aA-bB%Some OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some os
    capitalized: aA-bB%Some OS → AA-bB%Some OS

    And subsequently by only remapping spaces to dashes:

    lower-cased: aA-bB%Some OS → aa-bb%some-os
    as-is: aA-bB%Some OS → aA-bB%Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some-os
    capitalized: aA-bB%Some OS → AA-bB%Some-OS

    Was the problem with just the "as-is" or how the formulation of casing
    is listed?

    Your wording is sometims very terse and assigning the virtual () (i.e.
    which ands and ors belong to each other) is sometime tricky, and yes,
    the "as is" made me wonder about "remapping". But of course, a 1:1
    mapping is a mapping as well'. (and the case c) I could not see from
    your text alone at all).

    And the third sentence thus reads (verbosely):
    In addition, for historical and backwards compatibility, the above casing attempts will be tried in the following order:
    a) First no remapping (keeping the name as is)
    b) Remapping spaces to dashes (‘B<->’).

    But this does not match your examples, so I guess I still haven't
    understood the third sentence.

    Thanks for the explanations.

    Greetings

    Helge


    --
    Dr. Helge Kreutzmann debian@helgefjell.de
    Dipl.-Phys. http://www.helgefjell.de/debian.php
    64bit GNU powered gpg signed mail preferred
    Help keep free software "libre": http://www.ffii.de/

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

    iQIzBAABCAAdFiEEbZZfteMW0gNUynuwQbqlJmgq5nAFAmNBrbgACgkQQbqlJmgq 5nAFwBAAlBFXQPaTSfrykqAifrnh9q8Wel8L6y6n+gQtIHyZJKFCVsF+w5tkRSzy bF0B852DXegqMI5bj90wUIRSd9aE5FFeZLpOErTHs+5H/2yBWH88BNMcRJe/Dz9c kWLsXqRy0Kxa8n8+dFXooYWIzo8ClvaCWIXx6vyrjkhOpCD8+9QPklxSHQwXzXRi E8PPwVrw3O2HMZJ3Mem/zufoqfhyNVMMV4SR4re5JubhWo6/WYjaWTWkyNWNAlJz grTIRMdxRM4P91su6R0M9/PqYfplWJv/i08xnnqPyjfXzy2gNro1sl3DQv4I6YHc xhwNmikPC9kkdeV2Rhwi7pSmMbeoOr4fHNFzEEDUsu8StebWdTR0ufA45prgicZk fYjpBiYt0MR8hu5cDRZLIAxS948CFdIIzhI0qMN6b3MhPWNV3RwlWr/tzYKGuVDw W/qJ+X3ZwN2z95/6zK7Bp7kQTksvyozcbBPNxeqW1QUzZHYVL2te6Bt3qlu/jUbt EBrqvv34kwzOhzeQpqJ6Dfn95oZvF+3epVXKxf8TNlkRF/MjdpysMSkXMWxQ5g40 4Kd8rS3iAmedXX8a5ggETfLLfpXkUwfJrIbyn7Q
  • From Guillem Jover@21:1/5 to Helge Kreutzmann on Sat Oct 8 19:40:02 2022
    On Sat, 2022-10-08 at 19:05:01 +0200, Helge Kreutzmann wrote:
    On Sat, Oct 08, 2022 at 06:42:46PM +0200, Guillem Jover wrote:
    This means that the code will try the following combinations, after
    having remapped the non-alphanum chars:

    lower-cased: aA-bB%Some OS → aa-bb-some-os
    as-is: aA-bB%Some OS → aA-bB-Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb-some-os
    capitalized: aA-bB%Some OS → AA-bB-Some-OS

    Ok, so I understand the 2nd sentence as follows (I write it verbose):
    Namely, the following variations are accepted as well:
    a) non-alphanumeric characters (‘B<[^A-Za-z0-9]>’) in the vendor name
    are mapped to dashes (‘B<->’) and all letters are lower-cased
    b) the vendor name is kept as it is

    Non-alphanumeric mapped to dashes, then b)

    c) all letters in the vendor name are lower cased and then first letter
    is capitalized

    Non-alphanumeric mapped to dashes, then c)

    d) all letters (?) in the vendor name are capitalized
    (since dpkg 1.21.10).

    Non-alphanumeric mapped to dashes, then only the first letter is
    upper-cased (which I understand to be synonymous with capitalizing).

    In addition, for "
    "historical and backwards compatibility, the above casing attempts will be "
    "tried first as-is with no remapping, and then by remapping spaces to dashes "
    "(‘B<->’). But these will be removed during the dpkg 1.22.x release cycle."

    This means they will be tried then first w/o remapping as follows:

    lower-cased: aA-bB%Some OS → aa-bb%some os
    as-is: aA-bB%Some OS → aA-bB%Some OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some os
    capitalized: aA-bB%Some OS → AA-bB%Some OS

    And subsequently by only remapping spaces to dashes:

    lower-cased: aA-bB%Some OS → aa-bb%some-os
    as-is: aA-bB%Some OS → aA-bB%Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some-os
    capitalized: aA-bB%Some OS → AA-bB%Some-OS

    Was the problem with just the "as-is" or how the formulation of casing
    is listed?

    Your wording is sometims very terse and assigning the virtual () (i.e.
    which ands and ors belong to each other) is sometime tricky,

    Sorry! :) I guess I tend to try to avoid what I perceive as
    unnecessary repetition, and expressing lists seems sometimes
    complicated.

    and yes,
    the "as is" made me wonder about "remapping". But of course, a 1:1
    mapping is a mapping as well'. (and the case c) I could not see from
    your text alone at all).

    And the third sentence thus reads (verbosely):
    In addition, for historical and backwards compatibility, the above casing attempts will be tried in the following order:
    a) First no remapping (keeping the name as is)
    b) Remapping spaces to dashes (‘B<->’).

    These would be, instead of the first phase of remapping
    non-alphanumeric to dashes, the a) and b) here would be applied, then
    the a/b/c/d from above would be repeated (for each of these two
    iterations.

    But this does not match your examples, so I guess I still haven't
    understood the third sentence.

    Ok, I've tried to reword the man page, how about the following, which introduced some repetition (which will eventually go away), and should hopefully be more clear? Otherwise we can iterate until it does. :)

    ,---
    The file should be named according to the vendor name.
    The usual convention is to name the vendor file using the vendor name
    in all lowercase, but some variation is permitted.
    Namely (since dpkg 1.21.10), first, non-alphanumeric characters (‘B<[^A-Za-z0-9]>’) are mapped to dashes (‘B<->’), then the resulting name will be tried in sequence by lower-casing it, as-is, lower-casing
    then capitalizing (that is upper-casing the first character), and only capitalizing.
    In addition, for historical and backwards compatibility, the name will
    be tried as-is without non-alphanumeric characters remapping, then
    the resulting name be tried in sequence by lower-casing it, as-is,
    lower-casing then capitalizing, and only capitalizing.
    And finally the name will be tried by remapping spaces to dashes (‘B<->’), then the resulting name will be tried in sequence by lower-casing it,
    as-is, lower-casing then capitalizing, and only capitalizing.
    But these will be removed during the dpkg 1.22.x release cycle.
    `---

    Thanks,
    Guillem

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Helge Kreutzmann@21:1/5 to Guillem Jover on Sat Oct 8 21:00:01 2022
    This is a MIME-formatted message. If you see this text it means that your E-mail software does not support MIME-formatted messages.

    Hello Guillem,
    On Sat, Oct 08, 2022 at 07:38:21PM +0200, Guillem Jover wrote:
    On Sat, 2022-10-08 at 19:05:01 +0200, Helge Kreutzmann wrote:
    On Sat, Oct 08, 2022 at 06:42:46PM +0200, Guillem Jover wrote:
    This means that the code will try the following combinations, after having remapped the non-alphanum chars:

    lower-cased: aA-bB%Some OS → aa-bb-some-os
    as-is: aA-bB%Some OS → aA-bB-Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb-some-os
    capitalized: aA-bB%Some OS → AA-bB-Some-OS

    Ok, so I understand the 2nd sentence as follows (I write it verbose): Namely, the following variations are accepted as well:
    a) non-alphanumeric characters (‘B<[^A-Za-z0-9]>’) in the vendor name
    are mapped to dashes (‘B<->’) and all letters are lower-cased
    b) the vendor name is kept as it is

    Non-alphanumeric mapped to dashes, then b)

    c) all letters in the vendor name are lower cased and then first letter
    is capitalized

    Non-alphanumeric mapped to dashes, then c)

    d) all letters (?) in the vendor name are capitalized
    (since dpkg 1.21.10).

    Non-alphanumeric mapped to dashes, then only the first letter is
    upper-cased (which I understand to be synonymous with capitalizing).

    I'm not a native speaker either, but capitalizing seems fine.

    In addition, for "
    "historical and backwards compatibility, the above casing attempts will be "
    "tried first as-is with no remapping, and then by remapping spaces to dashes "
    "(‘B<->’). But these will be removed during the dpkg 1.22.x release cycle."

    This means they will be tried then first w/o remapping as follows:

    lower-cased: aA-bB%Some OS → aa-bb%some os
    as-is: aA-bB%Some OS → aA-bB%Some OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some os
    capitalized: aA-bB%Some OS → AA-bB%Some OS

    And subsequently by only remapping spaces to dashes:

    lower-cased: aA-bB%Some OS → aa-bb%some-os
    as-is: aA-bB%Some OS → aA-bB%Some-OS
    lower-cased and capitalized: aA-bB%Some OS → Aa-bb%some-os
    capitalized: aA-bB%Some OS → AA-bB%Some-OS

    Was the problem with just the "as-is" or how the formulation of casing
    is listed?

    Your wording is sometims very terse and assigning the virtual () (i.e. which ands and ors belong to each other) is sometime tricky,

    Sorry! :) I guess I tend to try to avoid what I perceive as
    unnecessary repetition, and expressing lists seems sometimes
    complicated.

    and yes,
    the "as is" made me wonder about "remapping". But of course, a 1:1
    mapping is a mapping as well'. (and the case c) I could not see from
    your text alone at all).

    And the third sentence thus reads (verbosely):
    In addition, for historical and backwards compatibility, the above casing attempts will be tried in the following order:
    a) First no remapping (keeping the name as is)
    b) Remapping spaces to dashes (‘B<->’).

    These would be, instead of the first phase of remapping
    non-alphanumeric to dashes, the a) and b) here would be applied, then
    the a/b/c/d from above would be repeated (for each of these two
    iterations.

    But this does not match your examples, so I guess I still haven't understood the third sentence.

    Ok, I've tried to reword the man page, how about the following, which introduced some repetition (which will eventually go away), and should hopefully be more clear? Otherwise we can iterate until it does. :)

    ,---
    The file should be named according to the vendor name.
    The usual convention is to name the vendor file using the vendor name
    in all lowercase, but some variation is permitted.
    Namely (since dpkg 1.21.10), first, non-alphanumeric characters (‘B<[^A-Za-z0-9]>’) are mapped to dashes (‘B<->’), then the resulting name will be tried in sequence by lower-casing it, as-is, lower-casing

    as → keeping it as-is

    then capitalizing (that is upper-casing the first character), and only capitalizing.

    capitalizing. → capitalizing it

    // If you want to optimize, then you can remove the bracketed term

    In addition, for historical and backwards compatibility, the name will
    be tried as-is without non-alphanumeric characters remapping, then
    the resulting name be tried in sequence by lower-casing it, as-is,

    name be → name will be

    as-is → keeping it as-is

    lower-casing then capitalizing, and only capitalizing.

    capitalizing. → capitalizing it.

    And finally the name will be tried by remapping spaces to dashes (‘B<->’),
    then the resulting name will be tried in sequence by lower-casing it,
    as-is, lower-casing then capitalizing, and only capitalizing.

    as-is → keeping it as-is
    capitalizing. → capitalizing it.

    But these will be removed during the dpkg 1.22.x release cycle.

    these → these mappings

    With these (editorial) additions I can translate it fine and hopefully
    I understand it as well. It really helps, and bits in documentation
    are cheap, so being a little more verbose in man pages is really
    helpful. (And I know, some man page writers go quite the opposite
    direction by repeating and extend quite a bit, but I think we are far
    from this here).

    Thanks for clarifying!

    Greetings

    Helge

    --
    Dr. Helge Kreutzmann debian@helgefjell.de
    Dipl.-Phys. http://www.helgefjell.de/debian.php
    64bit GNU powered gpg signed mail preferred
    Help keep free software "libre": http://www.ffii.de/

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

    iQIzBAABCAAdFiEEbZZfteMW0gNUynuwQbqlJmgq5nAFAmNBxkgACgkQQbqlJmgq 5nD6AA//c+sSCaVzbL62E+0hnx7s4yVwp2G6dj9EUqQgyDpRYIodW6cOpejgbWgg 7rNW2/Z3xonZ3OlPsQThAMqH8EgRBJGbtBpGtgMt1VAIdv0B7ExoEp6m6eqoNxYl ltHtfN3P26FwIBuYZZmqKptJfwhdIZoz3447otUtN0uKz9wqFW2gFpdI9+UnwBbv D8VuLD7SqEPFXvYLJl7lxeMkDMrBwyy7YncXhLyzJHFEzqEjxVRPAvb1GQtA2hta W/vNoFOLlz23KKShy7uQ6cHeHFnoR0NK1VxXlry2hR4T2S27bpydH0IQ7rYxA5Wq h158bFP4f3ygvT10epwUeXgAhHdOIwfFAKPBUsjbpzqhh/EbErNpj5F9lJrgv5J/ 4XVTwcAYL76N58VYizsxon+8wgkGUqJ+I15U7sX+nBxadNEGxDwE2jh1wFfeTKZP OGoefffYgTdfNGOKPW68MXGy9jh9timbRVsgMrnnvK2kM+W1veGJAeFo6HWIlp0d 2vm8o1dUNwZKjh0t+u0ynm63Y8m1qqqxQGUEzpPLzF0IWyCeui4GG2wP4ISHpcPY dZv28Hh0VktZMQ/MEP+6r7llDvLcQ84D7XLuWdh