Skip to content

Commit 21614d8

Browse files
committed
Generate USAGE.md programmatically
Closes #66.
1 parent 372dd5f commit 21614d8

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

qr-backup

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -835,15 +835,15 @@ def create_tar(input_paths):
835835

836836
def show_help(error=None, special_error=None):
837837
if error:
838-
print(HELP, file=sys.stderr)
838+
print(HELP, file=sys.stderr, end='')
839839
print(file=sys.stderr)
840840
print("ERROR: {}".format(error), file=sys.stderr)
841841
if isinstance(special_error, int):
842842
sys.exit(error)
843843
else:
844844
sys.exit(1)
845845
else:
846-
print(HELP)
846+
print(HELP, end='')
847847
sys.exit(0)
848848

849849
def add_label(image, text, side="bottom", max_fontsize=24, max_width=None, label=None):
@@ -1447,6 +1447,12 @@ def generate_docs(pages):
14471447
with open("docs/MAN.txt", "w") as f:
14481448
subprocess.run(["man", "-l", "docs/qr-backup.1.man"], stdout=f, env={"MANWIDTH": "80"})
14491449

1450+
with open("docs/USAGE.md", "w") as f:
1451+
f.write("Output of `qr-backup --help`:\n\n```\n")
1452+
f.flush()
1453+
subprocess.run(["./qr-backup", "--help"], stdout=f)
1454+
f.write("```\n")
1455+
14501456
def self_test_restore(restore_cmd, input_path, output_path, output_buffer, original_content, use_buffers, sha256sum, use_encryption, encryption_passphrase, expected_qrs):
14511457
if use_encryption:
14521458
test_restore_cmd = restore_cmd.replace("gpg --decrypt", "gpg --decrypt --no-symkey-cache --batch --passphrase '{}'".format(encryption_passphrase))

0 commit comments

Comments
 (0)