Skip to content

Commit 372dd5f

Browse files
committed
Disable self-check by default.
I'm going to disable self-test as a whole for the time being. It was a good idea in theory, but it's a bad user experience in the current state to get constant false positives. It was a mistake that I left it on even a tenth this long. I think I had the vague idea that it would get me/others to fix zbarimg's reliability, but that logic was clearly wrong (and was not user-centric enough)
1 parent b5090c2 commit 372dd5f

5 files changed

Lines changed: 21 additions & 21 deletions

File tree

docs/CHANGELOG

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
(unreleased)
2+
- Disabled self-check by default, because there are too many false positives from zbarimg's flaky QR scanning from PDF
23
- PDF output is more reproducible across Pillow versions
34
- Added continuous integration
45
- Fixed bugs

docs/MAN.txt

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ BACKUP OPTIONS
9292
Default: yes if erasure coding is enabled (default), no otherwise
9393

9494
--skip-checks, --no-skip-checks
95-
Skip erasure code checks, self-restore checks. Default: not
96-
skipped
95+
Skip erasure code checks, self-restore checks. Default: skipped
9796

9897
RESTORE OPTIONS
9998
--code-count-erasure COUNT
@@ -106,11 +105,11 @@ RESTORE OPTIONS
106105
Force decompression (on/off). Default: automatic
107106

108107
--display, --no-display
109-
For webcam scanning, (display/don't display) a webcam preview.
108+
For webcam scanning, (display/don't display) a webcam preview.
110109
Default: display
111110

112111
--encrypt PASSPHRASE, --no-encrypt
113-
Force decryption (on/off) and give the passphrase if decrypting.
112+
Force decryption (on/off) and give the passphrase if decrypting.
114113
Default: automatic
115114

116115
--image-restore
@@ -120,15 +119,15 @@ RESTORE OPTIONS
120119
Set the restore file path. Default: stdout
121120

122121
--sha256 SHA256
123-
Include a sha256sum to check the file. Giving the initial part
122+
Include a sha256sum to check the file. Giving the initial part
124123
of the sha256sum does a partial check. Default: no check, prints
125124
checksum to stderr
126125

127126
--webcam-restore
128127
Force webcam-based restore. Default: automatic
129128

130129
EXIT VALUES
131-
0 Success. This includes certain self-test failures which some-
130+
0 Success. This includes certain self-test failures which some-
132131
times fail by chance.
133132

134133
1 Invalid command line option
@@ -148,30 +147,30 @@ EXIT VALUES
148147
BUGS
149148
Please report any bugs at https://github.com/za3k/qr-backup/issues .
150149

151-
Sometimes scanned images, including the original PDF, cannot be read
150+
Sometimes scanned images, including the original PDF, cannot be read
152151
successfully and the restore self-check fails. This appears to be a bug
153152
in zbar.
154153

155-
On Debian, Ubuntu and certain other systems, the default system image-
154+
On Debian, Ubuntu and certain other systems, the default system image-
156155
magick policy prevents reading or writing PDFs. Since qr-backup depends
157-
on both, it will fail. qr-backup does its best to report this problem
156+
on both, it will fail. qr-backup does its best to report this problem
158157
clearly.
159158

160-
It is possible to print barcodes so large or small your webcam or scan-
159+
It is possible to print barcodes so large or small your webcam or scan-
161160
ner cannot read them. Make sure to test your restore process when using
162161
non-default settings.
163162

164163
COPYRIGHT
165-
qr-backup was written by Zachary Vance, and is released into the public
166-
domain and under CC0 <https://creativecommons.org/share-your-work/pub-
164+
qr-backup was written by Zachary Vance, and is released into the public
165+
domain and under CC0 <https://creativecommons.org/share-your-work/pub-
167166
lic-domain/cc0/>. The generated PDF includes the DejaVu Sans Mono font,
168-
which has a separate license <https://dejavu-fonts.github.io/Li-
167+
which has a separate license <https://dejavu-fonts.github.io/Li-
169168
cense.html>.
170169

171-
The qr-backup source code is available at <https://github.com/za3k/qr-
170+
The qr-backup source code is available at <https://github.com/za3k/qr-
172171
backup>.
173172

174173
AUTHORS
175174
Zachary Vance.
176175

177-
qr-backup 1.1.3 March 2025 QR-BACKUP(1)
176+
qr-backup 1.1.4 August 2025 QR-BACKUP(1)

docs/USAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Backup options:
7777
Default: yes if erasure coding is enabled (default), no otherwise
7878
--skip-checks, --no-skip-checks
7979
Skip erasure code checks, self-restore checks.
80-
Default: not skipped
80+
Default: skipped
8181
8282
8383
Restore options:

docs/qr-backup.1.man

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.1.12.1
1+
.\" Automatically generated by Pandoc 3.1.12.3
22
.\"
3-
.TH "QR\-BACKUP" "1" "March 2025" "qr\-backup 1.1.3" ""
3+
.TH "QR\-BACKUP" "1" "August 2025" "qr\-backup 1.1.4" ""
44
.SH NAME
55
qr\-backup \- back up file(s) to a series of QR codes on paper
66
.SH SYNOPSIS
@@ -114,7 +114,7 @@ Default: yes if erasure coding is enabled (default), no otherwise
114114
.TP
115115
\f[B]\-\-skip\-checks\f[R], \f[B]\-\-no\-skip\-checks\f[R]
116116
Skip erasure code checks, self\-restore checks.
117-
Default: not skipped
117+
Default: skipped
118118
.SH RESTORE OPTIONS
119119
.TP
120120
\f[B]\-\-code\-count\-erasure \f[BI]COUNT\f[B]\f[R]

qr-backup

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ BACKUP_OPTIONS = [
5858
(("--qr-version VERSION",), "10", "Uses QR codes, version VERSION. Versions range from 1-40. The bigger the version, the harder to scan but the more data per code."),
5959
(("--scale SCALE",), "5px", "Scale QR codes so that each small square in the QR code is SCALE x SCALE pixels."),
6060
(("--shuffle", "--no-shuffle"), "yes if erasure coding is enabled (default), no otherwise", "Spread QR codes across pages. This can help prevent data loss."),
61-
(("--skip-checks", "--no-skip-checks"), "not skipped", "Skip erasure code checks, self-restore checks."),
61+
(("--skip-checks", "--no-skip-checks"), "skipped", "Skip erasure code checks, self-restore checks."),
6262
]
6363
RESTORE_OPTIONS = [
6464
(("--code-count-erasure COUNT",), "automatic", "Specify the number of erasure QR codes."),
@@ -955,7 +955,7 @@ def main_backup(args):
955955
use_shuffle = None
956956
use_tar = False
957957
num_copies = 1
958-
do_checks = True
958+
do_checks = False # Disabled until zbar is less flaky (aka never)
959959
verbose = False
960960

961961
# parse arguments

0 commit comments

Comments
 (0)