From 37b279e63e7421a3b84d09971e2faf07daa09f5c Mon Sep 17 00:00:00 2001 From: Philipp Storz Date: Wed, 28 Nov 2018 12:09:27 +0100 Subject: [PATCH] update --- docs/manuals/en/new_main_reference/replace.sh | 14 ++++++++++++-- .../new_main_reference/source/autochangers.rst | 2 +- .../new_main_reference/source/catmaintenance.rst | 14 +++++++------- .../en/new_main_reference/source/pools.rst | 2 +- .../en/new_main_reference/source/programs.rst | 4 ++-- .../new_main_reference/source/releasenotes.rst | 16 ++++++++-------- .../source/troubleshooting.rst | 2 +- .../en/new_main_reference/source/update.rst | 6 +++--- 8 files changed, 35 insertions(+), 25 deletions(-) diff --git a/docs/manuals/en/new_main_reference/replace.sh b/docs/manuals/en/new_main_reference/replace.sh index cb3ecbdc5af..be7afa5e88d 100755 --- a/docs/manuals/en/new_main_reference/replace.sh +++ b/docs/manuals/en/new_main_reference/replace.sh @@ -119,11 +119,15 @@ sed -i -E 's#\{bconsole\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' *. #greater or equal sign sed -i -E 's#\$\\ge\$#≥#g' *.rst +sed -i -E 's#\$\\geq\$#≥#g' *.rst +sed -i -E 's#\$<\$#<#g' *.rst +sed -i -E 's#\$<=\$#≤#g' *.rst # \user -sed -i -E 's|:raw-latex:`\\user\{(.*)\}`|**\1**|g' *.rst +sed -i -E 's#:raw-latex:`\\user\{(.*)\}`#**\1**#g' *.rst +sed -i -E 's#\\user\{(.*)\}#**\1**#g' *.rst # \parameter -sed -i -E 's|:raw-latex:`\\parameter\{(.*)\}`|:option:`\1`|g' *.rst +sed -i -E 's#:raw-latex:`\\parameter\{(.*)\}`#:option:`\1`#g' *.rst # remove xml stuff @@ -138,6 +142,8 @@ sed -i -E 's#:raw-latex:`\\resourcetype\{(.*)\}\{(.*)\}`#:sup:`\1`\ :strong:`\2` # \name sed -i -E 's#:raw-latex:`\\name\{(.*)\}`#**\1**#g' *.rst +# \dbtable +sed -i -E 's#\\dbtable\{(.*)\}#**\1**#g' *.rst # resourcename @@ -145,12 +151,15 @@ sed -i -E 's#:raw-latex:`\\resourcename\{(.*)\}\{(.*)\}\{(.*)\}`#**\3**:sup:`\1` perl -i -pe 's#:raw-latex:`\\argument\{(.*?)\}`#:strong:`\1`#g' *.rst + + sed -i -E 's#:raw-latex:`\\job\{(.*)\}`#**\1**:sup:`Dir`:sub:`job`\ #g' *.rst sed -i -E 's#:raw-latex:`\\pool\{(.*)\}`#**\1**:sup:`Dir`:sub:`pool`\ #g' *.rst perl -i -pe 's#^.. raw:: latex$##g' *.rst +perl -i -pe 's#\\variable\{(.*?)\}#:envvar:`\1`#g' *.rst #\dt @@ -173,6 +182,7 @@ sed -i -E 's#:raw-latex:`\\linkResourceDirective\{(.*)\}\{(.*)\}\{(.*)\}`#**\3** perl -i -pe 's#:raw-latex:`\\host\{(.*?)\}`#:strong:`\1`#g' *.rst # TODO: check if |xxxx| replace can be used +sed -i 's#\\configFileDirUnix#:file:`/etc/bareos/bareos-dir.conf`#g' *.rst sed -i 's#:raw-latex:`\\fileStoragePath`#:file:`/var/lib/bareos/storage/`#g' *.rst sed -i 's#:raw-latex:`\\scriptPathUnix`#:file:`/usr/lib/bareos/scripts/`#g' *.rst sed -i 's#:raw-latex:`\\configPathUnix`#:file:`/etc/bareos/`#g' *.rst diff --git a/docs/manuals/en/new_main_reference/source/autochangers.rst b/docs/manuals/en/new_main_reference/source/autochangers.rst index 631a2c4e8c3..b484fa63827 100644 --- a/docs/manuals/en/new_main_reference/source/autochangers.rst +++ b/docs/manuals/en/new_main_reference/source/autochangers.rst @@ -1074,7 +1074,7 @@ by those tools to be able to open the medium. Example using :program:`bls` with a tape that was written with another blocksize than the -:raw-latex:`\variable{DEFAULT_BLOCK_SIZE}` (63k), but with the default +:raw-latex:`:envvar:`DEFAULT_BLOCK_SIZE`` (63k), but with the default label block size of 63k: diff --git a/docs/manuals/en/new_main_reference/source/catmaintenance.rst b/docs/manuals/en/new_main_reference/source/catmaintenance.rst index d0bf88442b1..e471271e402 100644 --- a/docs/manuals/en/new_main_reference/source/catmaintenance.rst +++ b/docs/manuals/en/new_main_reference/source/catmaintenance.rst @@ -83,7 +83,7 @@ changes. .. warning:: - When using the PostgreSQL backend and updating to Bareos $<$ 14.2.3, it is necessary to manually grant database permissions (\command{grant_bareos_privileges}), normally by + When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions (\command{grant_bareos_privileges}), normally by @@ -162,7 +162,7 @@ db_name - - environment variable :raw-latex:`\variable{db_name}` + - environment variable :raw-latex:`:envvar:`db_name`` - **DB Name**:sup:`Dir`:sub:`Catalog` from the configuration @@ -174,7 +174,7 @@ db_user - - environment variable :raw-latex:`\variable{db_user}` + - environment variable :raw-latex:`:envvar:`db_user`` - **DB User**:sup:`Dir`:sub:`Catalog` from the configuration @@ -186,7 +186,7 @@ db_password - - environment variable :raw-latex:`\variable{db_password}` + - environment variable :raw-latex:`:envvar:`db_password`` - **DB Password**:sup:`Dir`:sub:`Catalog` from the configuration @@ -524,7 +524,7 @@ For the Bareos database connection, you should specify a database password. Otherwise the Bareos database user gets the permission to connect without password. This is not recommended. Choose a database password and add it into the Bareos Director configuration file -:file:`/etc/bareos/bareos-dir.conf`: +:raw-latex:`:file:`/etc/bareos/bareos-dir.conf``: @@ -547,7 +547,7 @@ password and add it into the Bareos Director configuration file After this, run the Bareos database preparation scripts. For Bareos :math:`<=` 13.2.2, the database password must be specified as -environment variable :raw-latex:`\variable{db_password}`. From +environment variable :raw-latex:`:envvar:`db_password``. From 13.2.3 the database password is read from the configuration, if no environment variable is given. @@ -1349,7 +1349,7 @@ that a distribution provides. \hide{ supporting MySQL >= 5.7 since bareos-17.2.4 - \limitation{MySQL}{MySQL $\geq$ 5.7 not supported}{% + \limitation{MySQL}{MySQL ≥ 5.7 not supported}{% MySQL 5.7 did change it behavior in some respects. The result is, that the Bareos database creation scripts do not work any more. For the time being, we advise to use MariaDB instead, which is also the default on most Linux distributions. See \ticket{705}. diff --git a/docs/manuals/en/new_main_reference/source/pools.rst b/docs/manuals/en/new_main_reference/source/pools.rst index 70c0f20fad5..f337baf6106 100644 --- a/docs/manuals/en/new_main_reference/source/pools.rst +++ b/docs/manuals/en/new_main_reference/source/pools.rst @@ -76,7 +76,7 @@ switching volumes, such as limiting the volume size. - \TODO{This chapter will get rewritten. Instead of limiting a Volume to one job, we will utilize \variable{Max Use Duration = 24 hours}. This prevents problems when adding more clients, because otherwise each job has to run seperat.} + \TODO{This chapter will get rewritten. Instead of limiting a Volume to one job, we will utilize :envvar:`Max Use Duration = 24 hours`. This prevents problems when adding more clients, because otherwise each job has to run seperat.} The next problem to resolve is recycling of Volumes. As you noted from above, the requirements are to be able to restore monthly for 6 months, diff --git a/docs/manuals/en/new_main_reference/source/programs.rst b/docs/manuals/en/new_main_reference/source/programs.rst index 1cfbddf1bb1..5b403644cfa 100644 --- a/docs/manuals/en/new_main_reference/source/programs.rst +++ b/docs/manuals/en/new_main_reference/source/programs.rst @@ -1936,8 +1936,8 @@ without asking. If you are using bvfs (e.g. used by :ref:`bareos-webui `), don’t eliminate orphaned path, else you will have to rebuild -:raw-latex:`\variable{brestore_pathvisibility}` and -:raw-latex:`\variable{brestore_pathhierarchy}` indexes. +:raw-latex:`:envvar:`brestore_pathvisibility`` and +:raw-latex:`:envvar:`brestore_pathhierarchy`` indexes. Normally you should never need to run :program:`bareos-dbcheck` in spite of the recommendations diff --git a/docs/manuals/en/new_main_reference/source/releasenotes.rst b/docs/manuals/en/new_main_reference/source/releasenotes.rst index 7f3c2d89666..3973c035909 100644 --- a/docs/manuals/en/new_main_reference/source/releasenotes.rst +++ b/docs/manuals/en/new_main_reference/source/releasenotes.rst @@ -140,17 +140,17 @@ releases are only published on https://download.bareos.com.\| \item \bareosFd is ready for HP-UX 11.31 (ia64). \item Linux Distribution: Bareos tries to provide packages for all current platforms. For details, refer to :ref:`section-packages`. \end{itemize} - \item Linux RPM packages: allow read access to /etc/bareos/ for all users (however, relevant files are still only readable for the user \user{bareos}). + \item Linux RPM packages: allow read access to /etc/bareos/ for all users (however, relevant files are still only readable for the user **bareos**). This allows other programs associated with Bareos to also use this directory. \end{itemize} - \item Denormalization of the \dbtable{File} database table + \item Denormalization of the **File** database table \begin{itemize} - \item The denormalization of the \dbtable{File} database table leads to enormous performance improvements in installation, which covering a lot of file (millions and more). + \item The denormalization of the **File** database table leads to enormous performance improvements in installation, which covering a lot of file (millions and more). \item For the denormalization the database schema must be modified. - \warning{Updating the database to schema version $\geq$ 2170 will increase the required disk space. + \warning{Updating the database to schema version ≥ 2170 will increase the required disk space. Especially it will require around twice the amount of the current database disk space during the migration.} - \item The \dbtable{Filename} database table does no longer exists. Therefore the \bcommand{.bvfs_*}{} commands do no longer output the \dbcolumn{FilenameId} column. + \item The **Filename} database table does no longer exists. Therefore the \bcommand{.bvfs_*}{} commands do no longer output the \dbcolumn{FilenameId** column. \end{itemize} \item NDMP\_NATIVE support has been added. This include the NDMP features DAR and DDAR. For details see :ref:`section-NdmpNative`. @@ -233,7 +233,7 @@ releases are only published on https://download.bareos.com.\| \sqlcommand{DROP INDEX PathId_JobId_FileIndex_FileNameId ON File;} \end{itemize} \end{itemize} - \item Utilize OpenSSL $\geq$ 1.1 if available + \item Utilize OpenSSL ≥ 1.1 if available \item Windows: fixes silent upgrade (\command{winbareos-*.exe /S}) \item Windows: restore attributes also on directories (not only on files) \item Fixes problem with SHA1 signature when compiled without OpenSSL (not relevant for bareos.org/bareos.com packages) @@ -619,7 +619,7 @@ plan to ensure this in future version of Bareos. \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2014-12-12 \\ Database Version & 2003 (unchanged)\\ - & Database update required if updating from version $<$ 14.2.\\ + & Database update required if updating from version < 14.2.\\ & See the :ref:`bareos-update` section for details.\\ Url & \releaseUrlDownloadBareosOrg{14.2} \\ & \releaseUrlDownloadBareosCom{14.2} \\ @@ -681,7 +681,7 @@ plan to ensure this in future version of Bareos. Url & \releaseUrlDownloadBareosCom{13.2} \\ \end{tabular} - It is known, that \command{drop_database} scripts will not longer work on PostgreSQL $<$ 8.4. However, as \command{drop_database} scripts are very seldom needed, package dependencies do not yet enforce PostgreSQL $>=$ 8.4. We plan to ensure this in future version of Bareos. + It is known, that \command{drop_database} scripts will not longer work on PostgreSQL < 8.4. However, as \command{drop_database} scripts are very seldom needed, package dependencies do not yet enforce PostgreSQL $>=$ 8.4. We plan to ensure this in future version of Bareos. } diff --git a/docs/manuals/en/new_main_reference/source/troubleshooting.rst b/docs/manuals/en/new_main_reference/source/troubleshooting.rst index b453c0202bc..cee73001582 100644 --- a/docs/manuals/en/new_main_reference/source/troubleshooting.rst +++ b/docs/manuals/en/new_main_reference/source/troubleshooting.rst @@ -298,7 +298,7 @@ In some situation, you receive an error message similar to this: ERROR: integer out of range The database column :raw-latex:`\dbcolumn{VolWrites}` in the -:raw-latex:`\dbtable{Media}` table stores the number of write accesses +:raw-latex:`**Media**` table stores the number of write accesses to a volume. It is only used for statistics. However, it has happened that the number of write accesses exceeds the diff --git a/docs/manuals/en/new_main_reference/source/update.rst b/docs/manuals/en/new_main_reference/source/update.rst index 745aa659287..b6af91554b8 100644 --- a/docs/manuals/en/new_main_reference/source/update.rst +++ b/docs/manuals/en/new_main_reference/source/update.rst @@ -54,7 +54,7 @@ see which Bareos updates do require a database scheme update. .. warning:: - Especially the upgrade to Bareos $\geq$ 17.2.0 restructures the \dbtable{File} database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space. + Especially the upgrade to Bareos ≥ 17.2.0 restructures the **File** database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space. Debian based Linux Distributions -------------------------------- @@ -70,7 +70,7 @@ will be automatically adapted by the Bareos packages. .. warning:: - When using the PostgreSQL backend and updating to Bareos $<$ 14.2.3, it is necessary to manually grant database permissions, normally by using + When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions, normally by using @@ -107,7 +107,7 @@ different preparations. More details can be found in chapter .. warning:: - If you're updating to Bareos $<=$ 13.2.3 and have configured the Bareos database during install using Bareos environment variables (\variable{db_name}, \variable{db_user} or \variable{db_password}, see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The \user{postgres} user normally does not have the required permissions. + If you're updating to Bareos ≤ 13.2.3 and have configured the Bareos database during install using Bareos environment variables (:envvar:`db_name`, :envvar:`db_user` or :envvar:`db_password`, see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file :file:`/etc/bareos/bareos-dir.conf`. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The **postgres** user normally does not have the required permissions. PostgreSQL ~~~~~~~~~~