1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 17:27:31 +00:00
borg/docs/usage
Andrey Bienkowski 37e1ae4735 Fix exceptions thrown by setup.py build_man
While doing some doc updates I needed a way to test them - to build
the documentation and inspect the output. I ran into an issue:
running python setup.py build_man was throwing exceptions:

1. The import-tar parser had a None description causing:

    File "/home/user/borg/setup_docs.py", line 451, in write_heading
      write(char * len(header))
    TypeError: object of type 'NoneType' has no len()

2. There was no docs/usage/import-tar.rst causing an exception too
2021-12-10 10:51:26 +03:00
..
general Merge pull request #5873 from ThomasWaldmann/disable-selftest-1.1 2021-07-03 12:31:13 +02:00
benchmark.rst docs: usage: add benchmark page 2017-06-07 00:42:43 +02:00
benchmark_crud.rst.inc build_usage 2019-09-07 00:27:17 +02:00
borgfs.rst [DOCS] #4587 – Make Sphinx warnings break docs build 2020-03-16 19:06:00 +01:00
borgfs.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
break-lock.rst.inc python setup.py build_usage 2017-07-23 17:12:01 +02:00
change-passphrase.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
check.rst docs: split usage 2017-06-07 00:38:48 +02:00
check.rst.inc resolve clarify borg check --verify-data (#5808) 2021-06-18 15:00:14 -05:00
common-options.rst.inc build_usage 2021-05-11 22:33:55 +02:00
compact.rst compact: move --cleanup-commits description from examples to docs 2019-05-06 23:10:07 +02:00
compact.rst.inc build_usage 2021-02-06 01:32:02 +01:00
config.rst Add borg config command (fixes #3304) 2017-11-23 14:51:54 -08:00
config.rst.inc build_usage 2019-09-07 00:27:17 +02:00
create.rst add examples for --paths-from-stdin, --paths-from-command, --paths-separator (#5644) 2021-01-27 00:15:14 +01:00
create.rst.inc build_usage 2021-05-11 22:33:55 +02:00
debug.rst docs: split usage 2017-06-07 00:38:48 +02:00
delete.rst Add a --list switch to borg delete (#5503) 2020-12-11 19:11:47 +01:00
delete.rst.inc build_usage 2021-02-06 01:32:02 +01:00
diff.rst add --json-lines option to diff command 2021-03-13 11:50:55 -05:00
diff.rst.inc build_usage 2021-05-11 22:33:55 +02:00
export-tar.rst.inc python setup.py build_usage 2017-07-23 17:12:01 +02:00
extract.rst docs: extract: move cwd note to --help 2017-06-21 00:16:25 +02:00
extract.rst.inc build_usage 2021-05-11 22:33:55 +02:00
general.rst Merge pull request #5048 from finefoot/patch-8 2020-04-11 22:18:37 +02:00
help.rst docs: split usage 2017-06-07 00:38:48 +02:00
help.rst.inc docs: clarify pp pattern type 2021-08-07 07:38:04 -04:00
import-tar.rst Fix exceptions thrown by setup.py build_man 2021-12-10 10:51:26 +03:00
info.rst docs: info: update and add examples 2017-06-29 11:49:27 +02:00
info.rst.inc build_usage 2019-09-07 00:27:17 +02:00
init.rst docs: clarify borg init's encryption modes 2020-04-16 21:35:33 +02:00
init.rst.inc build_usage 2020-04-21 22:56:55 +02:00
key.rst allow key-import+BORG_KEY_FILE to create key files 2020-06-04 19:29:15 -07:00
key_change-passphrase.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
key_export.rst.inc fix typo: allows to -> allows one to 2018-01-03 11:42:38 +01:00
key_import.rst.inc build_usage 2020-10-04 20:32:38 +02:00
key_migrate-to-repokey.rst.inc python setup.py build_usage 2017-07-23 17:12:01 +02:00
list.rst docs: clarify pattern usage with commands (#5959) 2021-08-21 16:02:11 +02:00
list.rst.inc build_usage 2020-10-04 20:32:38 +02:00
lock.rst docs: split usage 2017-06-07 00:38:48 +02:00
mount.rst docs: give examples for borg mount exclusion options 2017-11-25 20:18:59 +01:00
mount.rst.inc build_usage 2021-05-11 22:33:55 +02:00
notes.rst Fix typos 2021-01-07 17:54:33 +01:00
prune.rst update docs about separated compaction 2018-07-14 14:53:23 +02:00
prune.rst.inc build_usage 2021-02-06 01:32:02 +01:00
recreate.rst docs: recreate: fix wrong "remove unwanted files" example 2017-07-21 11:51:46 +02:00
recreate.rst.inc build_usage 2020-10-04 20:32:38 +02:00
rename.rst docs: split usage 2017-06-07 00:38:48 +02:00
rename.rst.inc docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
serve.rst remove superfluous whitespace in docs 2019-06-09 14:45:18 +02:00
serve.rst.inc build_usage 2019-02-24 20:39:42 +01:00
tar.rst docs: fix examples with problematic option placements, fixes #3356 2017-11-25 19:29:34 +01:00
umount.rst.inc docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
upgrade.rst Name backup directories with 'before-upgrade' 2017-07-15 16:23:08 +02:00
upgrade.rst.inc build_usage 2019-09-07 00:27:17 +02:00
usage_general.rst.inc [DOCS] #4587 – Make Sphinx warnings break docs build 2020-03-16 19:22:59 +01:00
with-lock.rst.inc build_usage 2019-02-24 20:39:42 +01:00