Bug#892565: codespell: please make the build reproducible

[Chris Lamb]

Source: codespell
Version: 1.11.0-1
Severity: wishlist
Tags: patch
User: reproducible-builds at lists.alioth.debian.org
Usertags: buildpath
X-Debbugs-Cc: reproducible-bugs at lists.alioth.debian.org

Hi,

Whilst working on the Reproducible Builds effort [0], we noticed
that codespell could not be built reproducibly as it includes the
absolute build path in the "default dictionary" part of the
generated manpage:

│ │ │ │ │  .TP
│ │ │ │ │  \fB\-D\fR FILE, \fB\-\-dictionary\fR=\fI\,FILE\/\fR
│ │ │ │ │  Custom dictionary file that contains spelling
│ │ │ │ │  corrections. If this flag is not specified or equals
│ │ │ │ │ -"\-" then default dictionary "/build/1st/codespell\-1.12
│ │ │ │ │ -\&.0/codespell_lib/data/dictionary.txt" is used. This
│ │ │ │ │ +"\-" then default dictionary "/build/codespell\-1.12.0/2
│ │ │ │ │ +nd/codespell_lib/data/dictionary.txt" is used. This
│ │ │ │ │  option can be specified multiple times.
│ │ │ │ │  .TP

Patch attached.

 [0] https://reproducible-builds.org/


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby at debian.org / chris-lamb.co.uk
       `-
-------------- next part --------------
--- a/debian/patches/reproducible-build.patch	1969-12-31 16:00:00.000000000 -0800
--- b/debian/patches/reproducible-build.patch	2018-03-10 09:43:10.436994091 -0800
@@ -0,0 +1,18 @@
+Description: Make the build reproducible
+Author: Chris Lamb <lamby at debian.org>
+Last-Update: 2018-03-10
+
+--- codespell-1.11.0.orig/codespell_lib/_codespell.py
++++ codespell-1.11.0/codespell_lib/_codespell.py
+@@ -220,9 +220,8 @@ def parse_options(args):
+                       action='append', metavar='FILE',
+                       help='Custom dictionary file that contains spelling '
+                            'corrections. If this flag is not specified or '
+-                           'equals "-" then default dictionary "%s" is used. '
+-                           'This option can be specified multiple times.' %
+-                      default_dictionary)
++                           'equals "-" then the default dictionary is used. '
++                           'This option can be specified multiple times.')
+     parser.add_option('-I', '--ignore-words',
+                       action='append', metavar='FILE',
+                       help='File that contains words which will be ignored '
--- a/debian/patches/series	2018-03-10 09:37:33.683246368 -0800
--- b/debian/patches/series	2018-03-10 09:43:08.340983180 -0800
@@ -0,0 +1 @@
+reproducible-build.patch