[Git][reproducible-builds/diffoscope][master] Update note for zipinfo/zipinfoverbose. (re. reproducible-builds/strip-nondeterminism#19)

[Chris Lamb (@lamby)]

Chris Lamb pushed to branch master at Reproducible Builds / diffoscope


Commits:
3f01ab7c by Chris Lamb at 2022-05-17T09:34:38-07:00
Update note for zipinfo/zipinfoverbose. (re. reproducible-builds/strip-nondeterminism#19)

- - - - -


1 changed file:

- diffoscope/comparators/zip.py


Changes:

=====================================
diffoscope/comparators/zip.py
=====================================
@@ -120,11 +120,21 @@ class BsdtarVerbose(Command):
 def zipinfo_differences(file, other):
     """
     Run all our zipinfo variants.
-    """
 
+    We only return the first kind of metadata command that returns some output.
+    The compromise here is that "zipinfo -v" returns more info and, if the .zip
+    files contain both extended and simple kinds differences, then this logic
+    will only show the simpler differences.
+
+    In practice, this can mean that the values of .zip "extra fields" can be
+    hidden (see, for example, reproducible-builds/strip-nondeterminism#19).
+    This is considered less bad than the inverse (ie. prefering to show the
+    output of "zipinfo -v" over merely "zipinfo") as this will result in
+    virtually unreadable diffs in the case that differences when the
+    differences in the .zip are conventional/common/simple.
+    """
     for x in (Zipinfo, ZipinfoVerbose, BsdtarVerbose):
         result = Difference.from_operation(x, file.path, other.path)
-        # We only return the 'best' one
         if result is not None:
             return [result]
 



View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/commit/3f01ab7cd6da03c720053404ee528a91ce9f71dd

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/commit/3f01ab7cd6da03c720053404ee528a91ce9f71dd
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20220517/6b4bfc50/attachment.htm>