From 02ada0348617385f0249f11f9a257d6bcf5d67e0 Mon Sep 17 00:00:00 2001 From: Marian Beermann Date: Sat, 17 Jun 2017 14:29:04 +0200 Subject: [PATCH 1/3] docs: remove more boxes around monospace --- docs/borg_theme/css/borg.css | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/borg_theme/css/borg.css b/docs/borg_theme/css/borg.css index 0ba4c01f0..2145284be 100644 --- a/docs/borg_theme/css/borg.css +++ b/docs/borg_theme/css/borg.css @@ -69,6 +69,12 @@ dt code { white-space: normal; } +code, +.rst-content tt.literal, +.rst-content tt.literal, +.rst-content code.literal, +.rst-content tt, +.rst-content code, p .literal, p .literal span { border: none; From 0288fff6b714dff5cb60286aaed5a59820352b9c Mon Sep 17 00:00:00 2001 From: Marian Beermann Date: Sat, 17 Jun 2017 14:29:14 +0200 Subject: [PATCH 2/3] docs: explain formatting --- docs/usage/general.rst | 4 ++++ docs/usage_general.rst.inc | 24 +++++++++++++----------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/usage/general.rst b/docs/usage/general.rst index 77b1b9acd..127ab6676 100644 --- a/docs/usage/general.rst +++ b/docs/usage/general.rst @@ -5,6 +5,10 @@ Borg consists of a number of commands. Each command accepts a number of arguments and options and interprets various environment variables. The following sections will describe each command in detail. +Commands, options, parameters, paths and such are ``set in fixed-width``. +Option values are `underlined`. Borg has few options accepting a fixed set +of values (e.g. ``--encryption`` of :ref:`borg_init`). + .. container:: experimental Experimental features are marked with red stripes on the sides, like this paragraph. diff --git a/docs/usage_general.rst.inc b/docs/usage_general.rst.inc index f349512a4..1aea4298d 100644 --- a/docs/usage_general.rst.inc +++ b/docs/usage_general.rst.inc @@ -105,14 +105,16 @@ Return codes Borg can exit with the following return codes (rc): -:: - - 0 = success (logged as INFO) - 1 = warning (operation reached its normal end, but there were warnings - - you should check the log, logged as WARNING) - 2 = error (like a fatal error, a local or remote exception, the operation - did not reach its normal end, logged as ERROR) - 128+N = killed by signal N (e.g. 137 == kill -9) +=========== ======= +Return code Meaning +=========== ======= +0 success (logged as INFO) +1 warning (operation reached its normal end, but there were warnings -- + you should check the log, logged as WARNING) +2 error (like a fatal error, a local or remote exception, the operation + did not reach its normal end, logged as ERROR) +128+N killed by signal N (e.g. 137 == kill -9) +=========== ======= If you use ``--show-rc``, the return code is also logged at the indicated level as the last log entry. @@ -127,8 +129,8 @@ Borg uses some environment variables for automation: General: BORG_REPO When set, use the value to give the default repository location. If a command needs an archive - parameter, you can abbreviate as `::archive`. If a command needs a repository parameter, you - can either leave it away or abbreviate as `::`, if a positional parameter is required. + parameter, you can abbreviate as ``::archive``. If a command needs a repository parameter, you + can either leave it away or abbreviate as ``::``, if a positional parameter is required. BORG_PASSPHRASE When set, use the value to answer the passphrase question for encrypted repositories. It is used when a passphrase is needed to access an encrypted repo as well as when a new @@ -337,7 +339,7 @@ Cache files (client only): Network (only for client/server operation): If your repository is remote, all deduplicated (and optionally compressed/ - encrypted) data of course has to go over the connection (ssh: repo url). + encrypted) data of course has to go over the connection (``ssh://`` repo url). If you use a locally mounted network filesystem, additionally some copy operations used for transaction support also go over the connection. If you backup multiple sources to one target repository, additional traffic From b1205a7932468aff314b0e91e15bbf498b788ba6 Mon Sep 17 00:00:00 2001 From: Marian Beermann Date: Sat, 17 Jun 2017 14:32:37 +0200 Subject: [PATCH 3/3] docs: fix too small text in tables --- docs/borg_theme/css/borg.css | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/borg_theme/css/borg.css b/docs/borg_theme/css/borg.css index 2145284be..805e72e57 100644 --- a/docs/borg_theme/css/borg.css +++ b/docs/borg_theme/css/borg.css @@ -69,6 +69,18 @@ dt code { white-space: normal; } +/* for some reason the rtd theme makes text in tables very small. + * fix that. + */ +.wy-table td, +.rst-content table.docutils td, +.rst-content table.field-list td, +.wy-table th, +.rst-content table.docutils th, +.rst-content table.field-list th { + font-size: 100%; +} + code, .rst-content tt.literal, .rst-content tt.literal,