1. Forum
  2. Usenet
  3. LINUX.DEBIAN.MAINT.EMACSE

  • Re: Debian specific instruction in upstream README

    From David Bremner@21:1/5 to Xiyue Deng on Sun May 11 08:30:01 2025
    Xiyue Deng <manphiz@gmail.com> writes:

    As a preliminary thought, I think a better place to add Debian specific instruction is probably the README.Debian file, which is a natural place
    for Debian specific information, and avoids the previous mentioned
    downsides by not touching upstream files.

    This was my first thought also.

    We may also make it a template and generate the installation, removal,
    and bug reporting sections if desired. I understand that some
    packages already make use of this file for package specific
    instructions, so this would need some care to avoid any conflicts.

    I think it will probably cause a few problems (maybe fixable, but I
    don't know how others feel about this) to automatically update
    README.Debian. This is already pretty widely in use in Debian at large
    (I did not count within the team).

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Sean Whitton@21:1/5 to All on Sat May 17 10:50:02 2025
    Hello,

    I think I am the person who first started doing this. With good git
    workflows, the maintenance cost is low. When I've done it, I've removed upstream instructions to avoid users thinking that there are any further
    steps required to use the package; that could cause them to waste time.
    I don't think the inconsistency to which you refer matters too much.

    --
    Sean Whitton

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

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

    iQJNBAEBCgA3FiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAmgoTAMZHHNwd2hpdHRv bkBzcHdoaXR0b24ubmFtZQAKCRBpW3rkvwZiQGW+D/9b8ckPJZuyG9efPqYtzXLJ x53md3TojJk6Y+KXEnQX2AeVzEDYvgY4Vsw9mIGfkvdXldFRM/G0CtfsFcH14OSW puOVRX+mEslVXOPPaeRlk9Y4XfyAuXStxuZQIy6NLWRYROkp3yTrEKig4+s5fPww Sjqtx02rtgF2Jn1YaFk+IrTml8zzY9nHabMv7r9hVll/6LQAdeUl2zsC6mzF/d8S oX1sK9F2KuJws0SIAgf8y39KBigCyWtzOUXdbT+1Zk/J4PMG1W2gFkEuRPjRe+rA vk6AxU5XpOXxG7kqOT3CIQl2TCxY++41i6cjM4BXTP1g3BA28Xk9CQM16C3r0X02 yE8QoQ0h20UoANxo5mbti6/M99fIaxAN3aVD0APyG9JBfk8Mh8bZvu4t0vV9o5Ho cEHvkCICg7IWlRKleZZhojjrcADmsfM9TIXcogmL8ldPmwsju4QM6QZIRYtkpOEC XU3ywHUDYggY6kJE33Xu9Cz0d64kc4oVR8FtCsaBSKVdFQ+3y+uYqISPVGxQt2wx znv0iq8uDwRuNnnaZonqwSmV5FuQknbzR9BDU9kfUHkNUvHQouffTQubznYudXN2 pRmpVKZQG+/yDVJkeMpP/2DSLCAjnwMM9TEAheXmqXSp+FRRjBRym6bYDNH80Jei vemcxp/aTZ42zPYrq/QsCA==fiwx
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Us
  • From Sean Whitton@21:1/5 to Xiyue Deng on Sat May 17 10:50:02 2025
    Hello,

    On Sat 10 May 2025 at 09:42pm -07, Xiyue Deng wrote:

    As a preliminary thought, I think a better place to add Debian specific instruction is probably the README.Debian file, which is a natural place
    for Debian specific information, and avoids the previous mentioned
    downsides by not touching upstream files.

    I think that we ought to feel free to modify upstream files. That's one
    of the things that makes Debian different from other distributions,
    which latter prioritise minimising changes to upstream's code.

    README.Debian is the correct place for instructions that are essentially Debian-specific, indeed. But then I think README ought to be patched to contain a reference to README.Debian so the user knows to look there :)

    I'd prefer not to install a README to /usr/share/doc at all, than to
    leave it full of things that aren't relevant to Debian users.

    --
    Sean Whitton

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

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

    iQJNBAEBCgA3FiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAmgoTJcZHHNwd2hpdHRv bkBzcHdoaXR0b24ubmFtZQAKCRBpW3rkvwZiQBPoD/9CYI7UY7oOM40x6WaBnN+3 kQRbMWEp2/aEICnnp/u2L9G2LaeivDk4TCP7quI26HiezIVTrp/KUwbJ6KwTrwgW A8ZPkpLKvQTa2dG+nq/xLq4KKrrDlTtCPvLWrTt/n8kaC4GWcXTMGSLQxx5DWv3z DLK2ZhpSd8gl2CIGuE1EGua4enOYMW/GKmc/oLy4Sbfw08MejrV1C3Kp3LvafUTr jW9/VruaGgRGiOtt4oa5xnRPm6oqXifsxgKtRtmc0m2D0R6JWo+Mp5ycdr3QLYL8 mzfR7oIi+vDaorq5DD46CBz54VOP6VbXSbThAax7pjHpUmhjCvThr+pvXsDVa1Df 0XlkaBJKByM5zIzwl3r82g70KbDN8hAn1k10osMLm85pmUAFpPgLBBk0zVIaLdUM rxoOU6OPXizsnWVVYL6lFhJWzbAj9z+Hy2v/e5xKKNoivqZMvZvpn66SBnrvPgrL sEbHFw/DtedypPvcaS/T79Th22PyE+inqS3wU4Sb0UiB7hTiTHgpeIk2qD2f4JWG L7jv3r+//jPGQGuWpF1oYje+EGrwhe7MQagIhc1HTBVcdpFyXHkqowpILsl+AQku Dc5wtK0WFUosSo/1sjpdUgbAWMc7go05iAMLiM39sXohy92mIfq6qkgagF5kEb2k G1Khb9rJEZIxQCiDqXdBcQ==x0f1
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Us
  • From Sean Whitton@21:1/5 to Xiyue Deng on Sun May 18 13:40:01 2025
    Hello,

    On Sat 17 May 2025 at 03:55am -07, Xiyue Deng wrote:

    Another of my concern is that this is not done for all addons (which was
    what I meant by inconsistently): some packages do this, some don't, and
    this could confuse users.

    Yeah I know that's what you were referring to there. I don't see it as
    a big problem.

    I don't think whether to allow patching README conflicts with what I'm proposing. After all, patching README should be allowed for any fixes.
    I'm just thinking that if we want to provide Debian specific
    information, it's better to do it for all addons (which DDPO reports 346 packages as of now), and being able to do it automatically would be most
    cost efficient for maintainers. Also, if the Debian instruction changes (e.g. apt-get -> apt), it becomes a single point of fix.

    Yes, sure, having something additional that's automatic would be cool.

    --
    Sean Whitton

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

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

    iQJNBAEBCgA3FiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAmgpxrsZHHNwd2hpdHRv bkBzcHdoaXR0b24ubmFtZQAKCRBpW3rkvwZiQP+9D/9iTLTfeQ4B8ro6k4+av5ID 6r8giGyUbj2JdJIIkqYoa04IgwTiex69Mh82P9PMSZ7qYpdY3UKEKZRwarIHj0u9 +94Sc3z0+tYQ676dNHm4xwd1r626H+NUIPtasszIeEV2nafr8owYFv5lYmtn2yZz uihoOXak96RoGlJbLlOLHRqpRB/f4blgjaUd7a1H31EtOOzLRfomuEU5OZlZzMkT AcrcptERKzZl2hBpXV99pd2mqN1UlkL0NQNc47GhXg9rJkn2K3xNCqJnbYkLg5Yn fasbuRukGQlxrKzDhbbGVnyhJUBmeYYLuJLPL79oIWgN/Ry9fuHkLb8mKxBSbwlr 1IS60qAamUy1jEYhV0aIBck/MOyvJ6Y+zx9cEu8clIRN8DKHfAOAZgR7ndYOaAuS bdFyTSb7LiA5xI7tLhgSGnggd6RPKoav7l6ginETvlnxCTFLUwLfLfiYdxJSKBNc TIurOpwv8uXlAaqbYzQVQhjXuyxIPkaDGGGoBU91ayLqL/DP3VUbIcP85qiWjxdH /U4QvgIkR6+KvBIVzrMgImZWk2I3U/KUGfsmptu1w0vp9XnxIRn4YeZixaCKA/G8 dJRzXus7KDPExn3PyBNkAUk0bauYqOc5SEczALNQJbj1C7UnPG+69+YGMhFTUtM9 xXzoFbq5heWTgm7Mim8LIg==WUNA
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Us