Bug#919402: devscripts: [salsa] documentation mentions both SALSA_TOKEN and SALSA_PRIVATE_TOKEN
On Thu 2019-01-17 07:07:02 +0100, Xavier wrote: > Is this better? > > diff --git a/scripts/salsa.pl b/scripts/salsa.pl > index 6cc9a234..e1084b20 100755 > --- a/scripts/salsa.pl > +++ b/scripts/salsa.pl > @@ -43,11 +43,17 @@ or > >SALSA_TOKEN_FILE=~/.dpt.conf > > -If you choose to link another file, it must contain a line with > something like: > +If you choose to link another file using SALSA_TOKEN_FILE, it must contain a > +line with something like: > >SALSA_PRIVATE_TOKEN= >SALSA_TOKEN= > > +This allows for example to use dpt(1) configuration file (~/.dpt.conf) which > +contains: > + > + DPT_SALSA_PRIVATE_TOKEN=abcdefghi > + > =head1 COMMANDS > > =head2 Managing users and groups well, i understand it now, but that's maybe thanks to your earlier explanation -- so i'm tainted :P I do like that you included the example for users of dpt. i'm not a user of dpt myself, but the example alone makes it a lot clearer what means (i'd earlier thought that i needed the literal angle brackets, for example, which struck me as odd, but hey people do odd stuff). If you're trying to write documentation that works for someone who doesn't already understand what's going on here, it would be good to explain that these two strings (SALSA_PRIVATE_TOKEN and SALSA_TOKEN) do exactly the same thing. otoh, is there a reason to support them both, rather than having one be the expected+supported mechanism, and the other be deprecated? If you're willing to deprecate one of them, you could offer a warning if the deprecated form is found, along with a recommendation of how to fix it. then, over the course of a debian release, you could simply drop the deprecated variant. i know it's nice to be clever and just magically work for everyone, but it makes explaining what's going on a lot harder. Simplicity makes for clearer explanations. Thanks for maintaining this tool! --dkg signature.asc Description: PGP signature
Bug#919402: devscripts: [salsa] documentation mentions both SALSA_TOKEN and SALSA_PRIVATE_TOKEN
Le 16/01/2019 à 21:58, Daniel Kahn Gillmor a écrit : > On Tue 2019-01-15 18:54:19 +0100, Xavier wrote: >> this feature allows one to use another file that contains one of this >> fields. This permits compatibility with dpt(1) tool (from >> pkg-perl-tools) which uses a ~/.dpt.conf that contains >> >> DPT_SALSA_PRIVATE_TOKEN= >> >> So this is not a bug ;-). Maybe documentation isn't clear on this. > > definitely not clear! i was setting this up and trying to understand > what i should choose here -- if i used _PRIVATE_, will it be treated > differently than if i did not? why should i choose one or the other? > > an update to the documentation that makes it clearer what's happening > would be great. > > thanks for helping to maintain devscripts! > >--dkg Is this better? diff --git a/scripts/salsa.pl b/scripts/salsa.pl index 6cc9a234..e1084b20 100755 --- a/scripts/salsa.pl +++ b/scripts/salsa.pl @@ -43,11 +43,17 @@ or SALSA_TOKEN_FILE=~/.dpt.conf -If you choose to link another file, it must contain a line with something like: +If you choose to link another file using SALSA_TOKEN_FILE, it must contain a +line with something like: SALSA_PRIVATE_TOKEN= SALSA_TOKEN= +This allows for example to use dpt(1) configuration file (~/.dpt.conf) which +contains: + + DPT_SALSA_PRIVATE_TOKEN=abcdefghi + =head1 COMMANDS =head2 Managing users and groups
Bug#919402: devscripts: [salsa] documentation mentions both SALSA_TOKEN and SALSA_PRIVATE_TOKEN
On Tue 2019-01-15 18:54:19 +0100, Xavier wrote: > this feature allows one to use another file that contains one of this > fields. This permits compatibility with dpt(1) tool (from > pkg-perl-tools) which uses a ~/.dpt.conf that contains > > DPT_SALSA_PRIVATE_TOKEN= > > So this is not a bug ;-). Maybe documentation isn't clear on this. definitely not clear! i was setting this up and trying to understand what i should choose here -- if i used _PRIVATE_, will it be treated differently than if i did not? why should i choose one or the other? an update to the documentation that makes it clearer what's happening would be great. thanks for helping to maintain devscripts! --dkg
Bug#919402: devscripts: [salsa] documentation mentions both SALSA_TOKEN and SALSA_PRIVATE_TOKEN
Le 15/01/2019 à 17:12, Daniel Kahn Gillmor a écrit : > Package: devscripts > Version: 2.19.2 > Severity: minor > > > from "man salsa", i see: > > - >If you choose to link another file, it must contain a line with >something like: > > SALSA_PRIVATE_TOKEN= > SALSA_TOKEN= > - > > But nothing else anywhere about SALSA_PRIVATE_TOKEN= -- and i don't > see SALSA_PRIVATE_TOKEN anywhere in > /usr/share/perl5/Devscripts/Salsa/Config.pm. maybe that line should be > removed from the example in the documentation? > > Thanks for your work on devscripts! > >--dkg Hello, this feature allows one to use another file that contains one of this fields. This permits compatibility with dpt(1) tool (from pkg-perl-tools) which uses a ~/.dpt.conf that contains DPT_SALSA_PRIVATE_TOKEN= So this is not a bug ;-). Maybe documentation isn't clear on this. Cheers, Xavier
Bug#919402: devscripts: [salsa] documentation mentions both SALSA_TOKEN and SALSA_PRIVATE_TOKEN
Package: devscripts Version: 2.19.2 Severity: minor from "man salsa", i see: - If you choose to link another file, it must contain a line with something like: SALSA_PRIVATE_TOKEN= SALSA_TOKEN= - But nothing else anywhere about SALSA_PRIVATE_TOKEN= -- and i don't see SALSA_PRIVATE_TOKEN anywhere in /usr/share/perl5/Devscripts/Salsa/Config.pm. maybe that line should be removed from the example in the documentation? Thanks for your work on devscripts! --dkg -- Package-specific info: --- /etc/devscripts.conf --- --- ~/.devscripts --- DEBSIGN_KEYID=0EE5BE979282D80B9F7540F1CCD2ED94D21739E9 -- System Information: Debian Release: buster/sid APT prefers testing-debug APT policy: (500, 'testing-debug'), (500, 'testing'), (200, 'unstable-debug'), (200, 'unstable'), (1, 'experimental-debug'), (1, 'experimental') Architecture: amd64 (x86_64) Foreign Architectures: i386 Kernel: Linux 4.19.0-1-amd64 (SMP w/4 CPU cores) Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE=en_US.UTF-8 (charmap=UTF-8) Shell: /bin/sh linked to /bin/dash Init: systemd (via /run/systemd/system) Versions of packages devscripts depends on: ii dpkg-dev 1.19.2 ii fakeroot 1.23-1 ii file 1:5.34-2 ii gnupg 2.2.12-1 ii gnupg22.2.12-1 ii gpgv 2.2.12-1 ii gpgv2 2.2.12-1 ii libc6 2.28-5 ii libfile-homedir-perl 1.004-1 ii libfile-which-perl1.23-1 ii libipc-run-perl 20180523.0-1 ii libmoo-perl 2.003004-2 ii libwww-perl 6.36-1 ii patchutils0.3.4-2 ii perl 5.28.1-3 ii python3 3.7.1-3 ii sensible-utils0.0.12 ii wdiff 1.2.2-2+b1 Versions of packages devscripts recommends: ii apt 1.8.0~alpha3 ii at 3.1.23-1 ii curl7.62.0-1 ii dctrl-tools 2.24-3 ii debian-keyring 2018.12.24 ii dput-ng [dput] 1.22 ii dupload 2.9.2 ii equivs 2.2.0 ii libdistro-info-perl 0.20 ii libdpkg-perl1.19.2 ii libencode-locale-perl 1.05-1 pn libgit-wrapper-perl ii libgitlab-api-v4-perl 0.15-1 pn liblist-compare-perl ii liblwp-protocol-https-perl 6.07-2 pn libsoap-lite-perl ii libstring-shellquote-perl 1.04-1 ii libtry-tiny-perl0.30-1 ii liburi-perl 1.76-1 pn licensecheck ii lintian 2.5.121 ii man-db 2.8.5-1 ii patch 2.7.6-3 ii python3-apt 1.7.0 ii python3-debian 0.1.33 ii python3-magic 2:0.4.15-2 ii python3-requests2.20.0-2 pn python3-unidiff pn python3-xdg ii strace 4.21-1 ii unzip 6.0-21 ii wget1.20.1-1 ii xz-utils5.2.2-1.3 Versions of packages devscripts suggests: pn adequate ii autopkgtest5.8 pn bls-standalone ii build-essential12.5 pn check-all-the-things pn cvs-buildpackage ii debhelper 12 ii devscripts-el 40.3 ii diffoscope 107 pn disorderfs pn dose-extra pn duck ii faketime 0.9.7-3 pn gnuplot pn how-can-i-help pn libauthen-sasl-perl ii libdbd-pg-perl 3.7.4-1+b1 pn libfile-desktopentry-perl pn libnet-smtps-perl pn libterm-size-perl ii libtimedate-perl 2.3000-2 pn libyaml-syck-perl ii mailutils [mailx] 1:3.5-2 ii mozilla-devscripts 0.53 pn mutt ii openssh-client [ssh-client]1:7.9p1-5 pn piuparts ii postgresql-client-10 [postgresql-client] 10.5-1 ii postgresql-client-11 [postgresql-client] 11.1-2 ii postgresql-client-9.5 [postgresql-client] 9.5.4-3 ii postgresql-client-9.6 [postgresql-client] 9.6.5-1 ii quilt 0.65-3 pn ratt ii reprotest 0.7.8 ii svn-buildpackage 0.8.7 ii w3m
