Debian Bug report logs - #893324
diffoscope: terminology used in docs about exclusion options

Toggle useless messages

Message #5 received at submit@bugs.debian.org (full text, mbox, reply):

From: Paul Wise <pabs@debian.org>

To: Debian Bug Tracking System <submit@bugs.debian.org>

Subject: diffoscope: mechanism to ignore changes to file modification dates

Date: Sun, 18 Mar 2018 09:31:33 +0800

[Message part 1 (text/plain, inline)]

Package: diffoscope
Version: 91
Severity: wishlist

When I am sponsoring packages I sometimes use diffoscope to compare
source packages. Often a lot of timestamps have changed but I don't
really care about timestamp changes when sponsoring packages, so it
would be nice to have a way to ignore the modification timestamp.
Here is an example of what I am seeing:

│ │ │   --- streamlink-0.10.0+dfsg/debian/source/format
│ │ ├── +++ streamlink-0.11.0+dfsg/debian/source/format
│ │ │ ├── stat {}
│ │ │ │ @@ -1,8 +1,8 @@
│ │ │ │  
│ │ │ │    Size: 12        	Blocks: 8          IO Block: 4096   regular file
│ │ │ │  Links: 1
│ │ │ │  Access: (0640/-rw-r-----)  Uid: ( 1000/    pabs)   Gid: ( 1000/    pabs)
│ │ │ │  
│ │ │ │ -Modify: 2018-01-23 22:55:45.000000000 +0000
│ │ │ │ +Modify: 2018-03-08 23:12:49.000000000 +0000
│ │ │ │  
│ │ │ │   Birth: -

-- System Information:
Debian Release: buster/sid
  APT prefers testing-debug
  APT policy: (900, 'testing-debug'), (900, 'testing'), (800, 'unstable-debug'), (800, 'unstable'), (790, 'buildd-unstable'), (700, 'experimental-debug'), (700, 'experimental'), (690, 'buildd-experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 4.14.0-3-amd64 (SMP w/4 CPU cores)
Locale: LANG=en_AU.utf8, LC_CTYPE=en_AU.utf8 (charmap=UTF-8), LANGUAGE=en_AU.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages diffoscope depends on:
ii  python3                3.6.4-1
ii  python3-distro         1.0.1-2
ii  python3-libarchive-c   2.1-3.1
ii  python3-magic          2:0.4.15-1
ii  python3-pkg-resources  38.4.0-1

Versions of packages diffoscope recommends:
ii  abootimg                         0.6-1+b2
ii  acl                              2.2.52-3+b1
ii  apktool                          2.3.1+dfsg-1
ii  binutils-multiarch               2.30-7
ii  bzip2                            1.0.6-8.1
ii  caca-utils                       0.99.beta19-2+b2
ii  colord                           1.3.3-2
ii  db-util                          5.3.1
ii  default-jdk [java-sdk]           2:1.8-59
ii  default-jdk-headless             2:1.8-59
pn  device-tree-compiler             <none>
pn  docx2txt                         <none>
ii  e2fsprogs                        1.43.9-2
ii  enjarify                         1:1.0.3-3
ii  fontforge-extras                 0.3-4
pn  fp-utils                         <none>
ii  genisoimage                      9:1.1.11-3+b2
ii  gettext                          0.19.8.1-4
ii  ghc                              8.0.2-11
ii  ghostscript                      9.22~dfsg-2
ii  giflib-tools                     5.1.4-2
ii  gnupg                            2.2.5-1
ii  imagemagick                      8:6.9.9.34+dfsg-3
ii  imagemagick-6.q16 [imagemagick]  8:6.9.9.34+dfsg-3
ii  jsbeautifier                     1.6.4-6
pn  libarchive-tools                 <none>
ii  llvm                             1:4.0-40
pn  mono-utils                       <none>
pn  odt2txt                          <none>
pn  oggvideotools                    <none>
ii  openjdk-8-jdk [java-sdk]         8u151-b12-1
ii  openssh-client                   1:7.6p1-4
ii  pdftk                            2.02-4+b2
ii  pgpdump                          0.31-0.2
ii  poppler-utils                    0.61.1-2
pn  procyon-decompiler               <none>
ii  python3-argcomplete              1.8.1-1
ii  python3-binwalk                  2.1.1-16
ii  python3-debian                   0.1.32
pn  python3-defusedxml               <none>
pn  python3-guestfs                  <none>
ii  python3-jsondiff                 1.1.1-1
ii  python3-progressbar              2.3-4
ii  python3-pyxattr                  0.6.0-2+b1
ii  python3-rpm                      4.14.0+dfsg1-2
ii  python3-tlsh                     3.4.4+20151206-1+b3
pn  r-base-core                      <none>
ii  rpm2cpio                         4.14.0+dfsg1-2
ii  sng                              1.1.0-1+b1
ii  sqlite3                          3.22.0-1
ii  squashfs-tools                   1:4.3-4
ii  tcpdump                          4.9.2-2
ii  unzip                            6.0-21
ii  vim-common                       2:8.0.1453-1
pn  xmlutils                         <none>
ii  xxd                              2:8.0.1453-1+b1
ii  xz-utils                         5.2.2-1.3

Versions of packages diffoscope suggests:
ii  libjs-jquery  3.2.1-1

-- no debconf information

-- 
bye,
pabs

https://wiki.debian.org/PaulWise

[signature.asc (application/pgp-signature, inline)]

Message #10 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Chris Lamb <lamby@debian.org>

To: Paul Wise <pabs@debian.org>, 893324@bugs.debian.org

Subject: Re: Bug#893324: diffoscope: mechanism to ignore changes to file modification dates

Date: Sun, 18 Mar 2018 02:02:07 +0000

tags 893324 + moreinfo
thanks

Hi Paul,

> it would be nice to have a way to ignore the modification timestamp.

Does this not already exist?

 $ mkdir a b
 $ touch a/foo
 $ sleep 1
 $ touch b/foo
 $ diffoscope --no-progress --exclude-directory-metadata a b
 $ echo $?
 0


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby@debian.org / chris-lamb.co.uk
       `-

Message #17 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Paul Wise <pabs@debian.org>

To: Chris Lamb <lamby@debian.org>, 893324@bugs.debian.org

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Sun, 18 Mar 2018 13:26:32 +0800

[Message part 1 (text/plain, inline)]

Control: retitle -1 diffoscope: terminology used in docs about exclusion options
Control: tags -1 - moreinfo

On Sun, 2018-03-18 at 02:02 +0000, Chris Lamb wrote:

> Does this not already exist?

..
>  $ diffoscope --no-progress --exclude-directory-metadata a b

Ah, woops.

I looked at the manual page but I searched for the word 'ignore' rather
than 'exclude' so I completely missed the section documenting the
availability of this option.

Lets turn this into a bug about that instead. I would suggest replacing
"Exclude" with "Exclude/ignore" within the docs about the options that exclude some parts of the diffoscope output.

-- 
bye,
pabs

https://wiki.debian.org/PaulWise

[signature.asc (application/pgp-signature, inline)]

Message #24 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Mattia Rizzolo <mattia@debian.org>

To: Paul Wise <pabs@debian.org>, 893324@bugs.debian.org

Cc: Chris Lamb <lamby@debian.org>

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Sun, 18 Mar 2018 15:47:09 +0100

[Message part 1 (text/plain, inline)]

Control: tag -1 pending

On Sun, Mar 18, 2018 at 01:26:32PM +0800, Paul Wise wrote:
> Lets turn this into a bug about that instead. I would suggest replacing
> "Exclude" with "Exclude/ignore" within the docs about the options that exclude some parts of the diffoscope output.

Please check out the latest commit, I added 'ignore' to help grepping
through the manpage.  Hopefully that's enough to cover your wish :)

-- 
regards,
                        Mattia Rizzolo

GPG Key: 66AE 2B4A FCCF 3F52 DA18  4D18 4B04 3FCD B944 4540      .''`.
more about me:  https://mapreri.org                             : :'  :
Launchpad user: https://launchpad.net/~mapreri                  `. `'`
Debian QA page: https://qa.debian.org/developer.php?login=mattia  `-

[signature.asc (application/pgp-signature, inline)]

Message #31 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Paul Wise <pabs@debian.org>

To: Mattia Rizzolo <mattia@debian.org>, 893324@bugs.debian.org

Cc: Chris Lamb <lamby@debian.org>

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Mon, 19 Mar 2018 08:19:37 +0800

[Message part 1 (text/plain, inline)]

On Sun, 2018-03-18 at 15:47 +0100, Mattia Rizzolo wrote:

> Please check out the latest commit, I added 'ignore' to help grepping
> through the manpage.  Hopefully that's enough to cover your wish :)

Yep. I realised I had commit access so I took the liberty of adding it
to all the other --exclude-* option documentation too. Hope that is OK.

-- 
bye,
pabs

https://wiki.debian.org/PaulWise

[signature.asc (application/pgp-signature, inline)]

Message #36 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Chris Lamb <lamby@debian.org>

To: Paul Wise <pabs@debian.org>, Mattia Rizzolo <mattia@debian.org>, 893324@bugs.debian.org

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Mon, 19 Mar 2018 00:39:27 +0000

Dear Paul,

> Yep. I realised I had commit access so I took the liberty of adding it
> to all the other --exclude-* option documentation too. Hope that is OK.

Perfect, thanks! :)


Best wishes,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby@debian.org / chris-lamb.co.uk
       `-

Message #41 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Holger Levsen <holger@layer-acht.org>

To: Paul Wise <pabs@debian.org>, 893324@bugs.debian.org

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Mon, 19 Mar 2018 07:46:39 +0000

[Message part 1 (text/plain, inline)]

On Sun, Mar 18, 2018 at 01:26:32PM +0800, Paul Wise wrote:
> >  $ diffoscope --no-progress --exclude-directory-metadata a b
> Lets turn this into a bug about that instead. I would suggest replacing
> "Exclude" with "Exclude/ignore" within the docs about the options that exclude some parts of the diffoscope output.

"Exclude/ignore" doesnt read nicely. Given the option is called
'exclude...' already, we could probably just explain that this causing
'ignore', so people will still find it using both terms.


-- 
cheers,
	Holger

[signature.asc (application/pgp-signature, inline)]

Message #46 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Paul Wise <pabs@debian.org>

To: Holger Levsen <holger@layer-acht.org>, 893324@bugs.debian.org

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Tue, 20 Mar 2018 10:20:45 +0800

[Message part 1 (text/plain, inline)]

On Mon, 2018-03-19 at 07:46 +0000, Holger Levsen wrote:

> "Exclude/ignore" doesnt read nicely. Given the option is called
> 'exclude...' already, we could probably just explain that this causing
> 'ignore', so people will still find it using both terms.

How about removing the "/ignore" and adding sentences like these:

Use this option to ignore files based on their names.
Use this option to disable commands that use a lot of resources.
Use this option to ignore permissions, timestamps, xattrs etc.

-- 
bye,
pabs

https://wiki.debian.org/PaulWise

[signature.asc (application/pgp-signature, inline)]

Message #51 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Holger Levsen <holger@layer-acht.org>

To: Paul Wise <pabs@debian.org>

Cc: 893324@bugs.debian.org

Subject: Re: Bug#893324: diffoscope: terminology used in docs about exclusion options

Date: Tue, 20 Mar 2018 11:19:50 +0000

[Message part 1 (text/plain, inline)]

On Tue, Mar 20, 2018 at 10:20:45AM +0800, Paul Wise wrote:
> How about removing the "/ignore" and adding sentences like these:
> 
> Use this option to ignore files based on their names.
> Use this option to disable commands that use a lot of resources.
> Use this option to ignore permissions, timestamps, xattrs etc.

sounds good to me.


-- 
cheers,
	Holger

[signature.asc (application/pgp-signature, inline)]

Message #56 received at 893324@bugs.debian.org (full text, mbox, reply):

From: Chris Lamb <lamby@debian.org>

To: 893324@bugs.debian.org

Cc: Paul Wise <pabs@debian.org>, Holger Levsen <holger@layer-acht.org>

Subject: Re: diffoscope: terminology used in docs about exclusion options

Date: Tue, 20 Mar 2018 13:00:14 +0000

tags 893324 + pending
thanks

> sounds good to me.

Applied in Git, thanks all!

  https://anonscm.debian.org/git/reproducible/diffoscope.git/commit/?id=0da118a131f95811c158c5d47e4d620d01a233ea


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby@debian.org / chris-lamb.co.uk
       `-

Message #61 received at 893324-close@bugs.debian.org (full text, mbox, reply):

From: Chris Lamb <lamby@debian.org>

To: 893324-close@bugs.debian.org

Subject: Bug#893324: fixed in diffoscope 92

Date: Thu, 22 Mar 2018 15:07:00 +0000

Source: diffoscope
Source-Version: 92

We believe that the bug you reported is fixed in the latest version of
diffoscope, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 893324@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Chris Lamb <lamby@debian.org> (supplier of updated diffoscope package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Format: 1.8
Date: Thu, 22 Mar 2018 10:28:44 -0400
Source: diffoscope
Binary: diffoscope
Built-For-Profiles: nocheck
Architecture: source all
Version: 92
Distribution: unstable
Urgency: medium
Maintainer: Reproducible builds folks <reproducible-builds@lists.alioth.debian.org>
Changed-By: Chris Lamb <lamby@debian.org>
Description:
 diffoscope - in-depth comparison of files, archives, and directories
Closes: 890904 891363 891903 892240 893183 893311 893324 893443
Changes:
 diffoscope (92) unstable; urgency=medium
 .
   [ Chris Lamb ]
 .
   * New features:
     - Show the list of supported file types in the manual and --help output. We
       can copy-paste this into the website, etc.. Thanks to Jonathan Dowland
       for the suggestion. (Closes: #893443)
     - Add support for comparing Gnumeric spreadsheets. (Closes: #893311)
 .
   * Bug fixes:
     - Additionally extract the classes.dex file from .apk files; apktool does
       not do this by default which was preventing us from recursing into it to
       find differences. Thanks to Hans-Christoph Steiner for the report.
       (Closes: #890904)
     - Recursively reset the permissions of temporary directories prior to
       deletion to ensure that non-writable permissions such as 0555 are removed
       and do not cause a traceback. (Closes: #891363)
     - Support the case where the python3-xattr package is installed but
       python3-pyxattr is not. Based on an patch by Doug Freed; thanks!
       (Closes: #892240)
     - Update Java tests for openjdk-9. (Closes: #893183)
 .
   * Output:
     - Print a nicer error message if you only specify one file to compare.
     - Don't show progress bar if we passed --debug as it just gets in the way.
 .
   * Code tidying:
     - Avoid some necessary indentation around unconditional control flow.
     - Tidy unnecessary assignments.
     - Move the documentation for maybe_decode into a docstring on the method
       itself.
     - Import LooseVersion as LooseVersion.
     - Use more Pythonic `old_level` variable names (over `oldLabel`) and avoid
       using ambiguous `l` variable names.
     - Add whitespace around operators and ensure 4-line indentation throughout.
 .
   * debian/*:
     - Move DOS/MBR check into the testsuite.
     - Add explicit runtime dependency on python3-distutils as it was dropped in
       src:python3.6 3.6.5~rc1-2.
 .
   * Misc:
     - Clarify that the Reproducible Builds project is not just about
     - Drop executable bit on doc/Makefile.
     - Use our bin/diffoscope wrapper in manpage generation to ensure we are
       using the local version of diffoscope.
 .
   [ Mattia Rizzolo ]
   * Update terminology used in docs about exclusion options. Thanks to Paul
     Wise for the idea. (Closes: #893324)
   * Don't try to decode a string in comparators.utils.file. (Closes: #891903)
   * Save a bunch of system calls by resetting tempfile permissions when
     we actually need to do it.
Checksums-Sha1:
 bf5454135e289dc72b6c90b701e236b4cf1aca96 3450 diffoscope_92.dsc
 4d2de0fd8ef3e408b3c9e0ef21424a8c13e19950 8941108 diffoscope_92.tar.xz
 26ca12fbbaac88d473ecefb8104d4970b5707bf7 119368 diffoscope_92_all.deb
 abb5d892ed2888c52b2ef71b211f6e7821e7f87d 6496 diffoscope_92_amd64.buildinfo
Checksums-Sha256:
 89825858473b26ef732bb12c0c63325ef292cc2d2c200a088d7a66e1bfe414cc 3450 diffoscope_92.dsc
 dc0ec115af492d91cc3512d71a0b0882847faa1319e381cdbbc4ec155d568e06 8941108 diffoscope_92.tar.xz
 e3b2e70a097f98b4c318dabf2dd09af84365d0e8c89a45f477dc1f4c91fa33d4 119368 diffoscope_92_all.deb
 fbcc092a28a5874a4b46b31e03a1f9b568363481d94953c4aaad67ac9bb47972 6496 diffoscope_92_amd64.buildinfo
Files:
 a91e7adac25c9b7a6a172ce72251327f 3450 devel optional diffoscope_92.dsc
 8e25a63003ead4b79ed3c1eb130a3470 8941108 devel optional diffoscope_92.tar.xz
 1859965190e58bd76231dcc9439d492b 119368 devel optional diffoscope_92_all.deb
 e0b84b217304d667e0ea353fd5a5d79c 6496 devel optional diffoscope_92_amd64.buildinfo

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

iQIzBAEBCAAdFiEEwv5L0nHBObhsUz5GHpU+J9QxHlgFAlqzv4AACgkQHpU+J9Qx
HlgZ1g/9GQQhyCZFU3KETg6AjGkNGyNAjYYD2FqKAJyM0bb3o9Zyg5QWvVPxFYHf
CDaKAwMQn6yws908OEfDPWGQAtowFGMPAXab9ejy9IvyD8wGXJ9iBXzgwtOWUCD7
hvyTCBKGRNwH/LdCWNfX1sNFX+usLDB5mlZytlRZe+aOUN+MKuRzNnDhl7wt6EU9
LiXsjqxdYDMJgBCIMcOJ50q3r8RkFjK7YCHeROrwiMRd/YGIR2i9Ed+g/zIkd2pr
ztgwec9nebOmHmFbWc6bqzKMVSkmejSyOjbZmmudTg0sUKrRF1qO/b5z9kEezSL6
VxyZKHHvqXBgAuwspvluJ4HWLifsWtwOIyg5xrcAAeeGm/j8RoIP8UanOyXbm8Bk
3+MsuGwZJEuNC7y2eiGx/HvcE2R9KK9UJlbIFeKKp16AYbLIINGTMDlHiYo9ItTz
Q77N4sbjSgKIuyBf3qzoyL0luWODVB5bpht+iCJxrOVnNDE2u8xFBYG/wTSxpftA
5X3pj1vPYy+1ozBDddaxOQppoDc/DHCgp6PWAf1K1/FvqNqrOPFiBaEg+L7QMthT
ADXhzB0+z6JnPU92URh7a0/rw+5hfU4dxZElCFznQhDLf8U3NngsSpCfnY3OK3Uu
qknLgJERC2K6iJrhVB023yksPPxAeTH7L+0BDpXeXFReJ6ldOCg=
=CTQP
-----END PGP SIGNATURE-----

Send a report that this bug log contains spam.