Skip to content

Commit

Permalink
mulitline waring
Browse files Browse the repository at this point in the history
  • Loading branch information
pstorz committed Nov 28, 2018
1 parent f925dcc commit fd523cf
Show file tree
Hide file tree
Showing 19 changed files with 66 additions and 77 deletions.
9 changes: 6 additions & 3 deletions docs/manuals/en/new_main_reference/replace.sh
Expand Up @@ -54,6 +54,10 @@ perl -i -pe 's#\\bcommand\{(.*?)\}\{}#:strong:`\1`#g' *.rst

perl -i -pe 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' *.rst

perl -i -pe 's#:raw-latex:`\\configline\{(.*?)\}`#:strong:`\1`#g' *.rst



# rename sec: to section- as : has special meaning in sphinx
sed -i -E 's#sec:#section-#g' *.rst
sed -i -E 's#item:#item-#g' *.rst
Expand Down Expand Up @@ -88,9 +92,8 @@ sed -i -E 's# .. raw:: latex##g' *.rst


# warning
sed -i -E 's|:raw-latex:`\\warning\{(.*)\}`|\n.. warning:: \n \1|g' *.rst
sed -i -E 's|\\warning\{(.*)\}|\n.. warning:: \n \1|g' *.rst

perl -i -0 -pe 's#:raw-latex:`\\warning\{(^[}]*)\}`#\n.. warning:: \n \1#ims' *.rst
perl -i -0 -pe 's#\\warning\{(.*)\}#\n.. warning:: \n \1#ims' *.rst
# sinceversion
# raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}`
sed -i -E 's|:raw-latex:`\\sinceVersion\{(.*)\}\{(.*)\}\{(.*)\}`|\3|g' *.rst
Expand Down
Expand Up @@ -194,7 +194,7 @@ during the daytime when no backups are executed.


.. warning::
All Bareos job resources have some required directives, e.g. \linkResourceDirective{Dir}{Job}{Client.
All Bareos job resources have some required directives, e.g. \linkResourceDirective{Dir}{Job}{Client}.
Even so, none other than the mentioned directives are evaluated by a \resourceDirectiveValue{Dir}{Job}{Type}{Consolidate},
they still have to be defined.
Normally all required directives are already set in \resourceDirectiveValue{Dir}{Job}{Job Defs}{DefaultJob}.
Expand Down Expand Up @@ -755,7 +755,7 @@ On remote machine:

- Add fileset which the client will be backed up.

- Add Pool with name **transfer**:sup:`Dir`:sub:`pool` where the data will
- Add Pool with name :raw-latex:`\pool{transfer` where the data will
be written to.

- create job that will backup the remote client with the remote fileset
Expand Down
6 changes: 4 additions & 2 deletions docs/manuals/en/new_main_reference/source/basejob.rst
Expand Up @@ -71,5 +71,7 @@ behavior with the ``BaseJob`` FileSet option. This option works like the



\warning{The current implementation doesn't permit to scan
volume with \command{bscan}. The result wouldn't permit to restore files easily.}

.. warning::
The current implementation doesn't permit to scan
volume with \command{bscan}. The result wouldn't permit to restore files easily.
4 changes: 2 additions & 2 deletions docs/manuals/en/new_main_reference/source/bconsole.rst
Expand Up @@ -732,7 +732,7 @@ configure
.. warning::
Don't be confused by the extensive output of \bcommand{help}{configure}. As \bcommand{configure}{add} allows configuring arbitrary resources, the output of \bcommand{help}{configure} lists all the resources, each with all valid directives. The same data is also used for \command{bconsole} command line completion.
Don't be confused by the extensive output of \bcommand{help}{configure}. As \bcommand{configure}{add} allows configuring arbitrary resources, the output of \bcommand{help}{configure} lists all the resources, each with all valid directives. The same data is also used for \command{bconsole} command line completion.}
Available since Bareos
16.2.4.
Expand Down Expand Up @@ -2580,7 +2580,7 @@ Adding Volumes to a Pool
\TODO{move to another chapter}
\TODO{move to another chapter
If you have used the **label** command to label a Volume, it will be
automatically added to the Pool, and you will not need to add any media
Expand Down
6 changes: 3 additions & 3 deletions docs/manuals/en/new_main_reference/source/catmaintenance.rst
Expand Up @@ -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}



Expand Down Expand Up @@ -1567,7 +1567,7 @@ a lock wait timeout. This can be seen as Bareos message, e.g.:
Fatal error: sql_create.c:899 Fill File table Query failed: INSERT INTO File (FileIndex, JobId, PathId, FilenameId, LStat, MD5, DeltaSeq) SELECT batch.FileIndex, batch.JobId, Path.PathId, Filename.FilenameId,batch.LStat, batch.MD5, batch.DeltaSeq FROM batch JOIN Path ON (batch.Path = Path.Path) JOIN Filename ON (batch.Name = Filename.Name): ERR=Lock wait timeout exceeded; try restarting transaction
In this case the
|mysql| :raw-latex:`\configline{innodb_lock_wait_timeout}`
|mysql| :strong:`innodb_lock_wait_timeout`
must be increased. A value of 300 should be sufficient.
Expand Down Expand Up @@ -1859,7 +1859,7 @@ following additional Director configuration statements:
File = "/var/lib/bareos/bareos.sql" # database dump
File = "/etc/bareos" # configuration
}
}
It is preferable to write/send the
:ref:`bootstrap <BootstrapChapter>` file to another
Expand Down
8 changes: 5 additions & 3 deletions docs/manuals/en/new_main_reference/source/configure.rst
Expand Up @@ -284,12 +284,14 @@ Resource file conventions

- Normally you should not remove resources that are already in use
(jobs, clients, ...). Instead you should disable them by adding
the directive :raw-latex:`\configline{Enable = no}`. Otherwise you
the directive :strong:`Enable = no`. Otherwise you
take the risk that orphaned entries are kept in the Bareos
catalog. However, if a resource has not been used or all
references have been cleared from the database, they can also be
removed from the configuration.
:raw-latex:`\warning{If you want to remove a configuration resource that is part of a Bareos package,
:raw-latex:`
.. warning::
If you want to remove a configuration resource that is part of a Bareos package,
replace the resource configuration file by an empty file.
This prevents the resource from reappearing in the course of a package update.}`

Expand Down Expand Up @@ -1505,7 +1507,7 @@ symbolic form. The File daemon then resolves it to an IP address. For
this reason you must use either an IP address or a resolvable fully
qualified name. A name such as :strong:`localhost`, not being
a fully qualified name, will resolve in the File daemon to the
:strong:`localhost` of the File daemon, which is most likely
:raw-latex:`\host{localhost` of the File daemon, which is most likely
not what is desired. The password used for the File daemon to authorize
with the Storage daemon is a temporary password unique to each Job
created by the daemons and is not specified in any .conf file.
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/en/new_main_reference/source/dataencryption.rst
Expand Up @@ -20,7 +20,7 @@ to unencrypted file contents.


.. warning::
These feature is only available, if Bareos is build against OpenSSL.
These feature is only available, if Bareos is build against OpenSSL.}

It is very important to specify what this implementation does NOT do:

Expand Down Expand Up @@ -164,7 +164,7 @@ Example Data Encryption Configurations (bareos-fd.conf)



\bconfigInput{config/FdClientPki.conf}
\bconfigInput{config/FdClientPki.conf

Decrypting with a Master Key
----------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/manuals/en/new_main_reference/source/disk.rst
Expand Up @@ -295,7 +295,9 @@ are the following:
- | **Purge Oldest Volume**:sup:`Dir`:sub:`Pool`
= yes: permits a forced recycling of the oldest Volume when a new
one is needed.
| :raw-latex:`\warning{This record ignores retention periods! We highly
| :raw-latex:`
.. warning::
This record ignores retention periods! We highly
recommend not to use this record, but instead use \linkResourceDirective{Dir}{Pool}{Recycle Oldest Volume}.}`

- **Maximum Volumes**:sup:`Dir`:sub:`Pool` :
Expand Down Expand Up @@ -696,4 +698,4 @@ Example: use four storage devices pointing to the same directory
RemovableMedia = no
AlwaysOpen = no
Maximum Concurrent Jobs = 1
}
9 changes: 3 additions & 6 deletions docs/manuals/en/new_main_reference/source/howto.rst
Expand Up @@ -82,9 +82,9 @@ need to consider some things:
| The database need to run in **Full Recovery Mode**. Otherwise you
are not able to use differential and incremental backups or to use
point in time recovery.
|
| :raw-latex:`
.. warning::
If you set the databases into the mentionend mode you have to consider some maintance facts. The database doesn't shrink or delete the logs unanttended, so you have to shrink them manual once a week and you have to truncate the logs once in a month.
If you set the databases into the mentionend mode you have to consider some maintance facts. The database doesn't shrink or delete the logs unanttended, so you have to shrink them manual once a week and you have to truncate the logs once in a month.}`

- | **Security and Access**
| For connections you can use a SQL-User or a integrated
Expand Down Expand Up @@ -1334,10 +1334,7 @@ like the following one:
.. code-block:: sh
:caption: bpipe shell script for a restore to filesystem
{bconfig}{bpipe shell script for a restore to filesystem
#!/bin/bash
cat - > /tmp/dump.sql
exit 0
9 changes: 3 additions & 6 deletions docs/manuals/en/new_main_reference/source/install.rst
Expand Up @@ -74,9 +74,9 @@ Bareos offers the following database backends:
- MariaDB/MySQL by package **bareos-database-mysql**

- | Sqlite by package **bareos-database-sqlite3**
|
| :raw-latex:`
.. warning::
The Sqlite backend is only intended for testing, not for productive use.
The Sqlite backend is only intended for testing, not for productive use.}`

PostgreSQL
^^^^^^^^^^
Expand Down Expand Up @@ -476,10 +476,7 @@ Start the daemons




.. code-block:: sh
:caption: Start the Bareos Daemons
{commands}{Start the Bareos Daemons
service bareos-dir start
service bareos-sd start
service bareos-fd start
Expand Down
14 changes: 5 additions & 9 deletions docs/manuals/en/new_main_reference/source/ndmp.rst
Expand Up @@ -631,13 +631,11 @@ Appliance.
.. warning::
Normally (\linkResourceDirective{Dir}{Client}{Protocol}=Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (\linkResourceDirective{Dir}{Client}{Protocol}=NDMP*), no \bareosFd is involved and therefore most Fileset options can't be used. Instead, parameters are handled via \configdirective{Options - Meta} from \linkResourceDirective{Dir}{FileSet}{Include}.
Normally (\linkResourceDirective{Dir}{Client}{Protocol}=Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (\linkResourceDirective{Dir}{Client}{Protocol}=NDMP*), no \bareosFd is involved and therefore most Fileset options can't be used. Instead, parameters are handled via \configdirective{Options - Meta} from \linkResourceDirective{Dir}{FileSet}{Include}.}




.. warning::
Avoid using multiple \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File directives.
\warning{Avoid using multiple \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File} directives.
The \bareosDir would try to handle them by running multiple NDMP jobs in a single Bareos job.
Even if this is working fine during backup, restore jobs will cause trouble.}

Expand Down Expand Up @@ -1303,9 +1301,7 @@ Now we successfully copied over the NDMP job.
.. warning::
\bcommand{list}{jobs} will only show the number of main backup files as JobFiles. However, with \bcommand{list}{files jobid=...} all files are visible.
\warning{\bcommand{list}{jobs} will only show the number of main backup files as JobFiles. However, with \bcommand{list}{files jobid=...} all files are visible.}
Restore to NDMP Primary Storage System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1540,7 +1536,7 @@ environment to use in the meta options for it.
}
}
The setting of :raw-latex:`\configline{"DIRECT = Y"}` is required for
The setting of :strong:`"DIRECT = Y"` is required for
Direct Access Recovery.
For more information, see :ref:`section-NdmpFileset`.
Expand Down Expand Up @@ -2341,7 +2337,7 @@ Temporary memory mapped database
On some 32-bit systems the default \linkResourceDirective{Dir}{Job}{File History Size} requires a larger memory area than available.
In this case, you either have to lower the \linkResourceDirective{Dir}{Job}{File History Size}
or preferably run the \bareosDir on a 64-bit system.
}
Tested Environments
-------------------
Expand Down
10 changes: 5 additions & 5 deletions docs/manuals/en/new_main_reference/source/programs.rst
Expand Up @@ -187,7 +187,9 @@ In the case of a tape, this is the physical device name such as



\warning{If you have Bareos running and you want to use

.. warning::
If you have Bareos running and you want to use
one of these programs, you will either need to stop the \bareosSd
or :strong:`unmount` any tape drive you want to use,
otherwise the drive may get busy because Bareos is using it.
Expand Down Expand Up @@ -826,9 +828,7 @@ Extracting Under Windows




.. warning::
If you use \command{bextract} under Windows, the ordering of the parameters is essential.
\warning{If you use \command{bextract} under Windows, the ordering of the parameters is essential.}

To use :program:`bextract`, the Bareos Storage Daemon must
be installed. As bextract works on tapes or disk volumes, these must be
Expand Down Expand Up @@ -1937,7 +1937,7 @@ If you are using bvfs (e.g. used by
:ref:`bareos-webui <section-webui>`), don’t eliminate
orphaned path, else you will have to rebuild
:raw-latex:`:envvar:`brestore_pathvisibility`` and
:raw-latex:`:envvar:`brestore_pathhierarchy`` indexes.
:raw-latex:`\variable{brestore_pathhierarchy` indexes.
Normally you should never need to run
:program:`bareos-dbcheck` in spite of the recommendations
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/en/new_main_reference/source/recycling.rst
Expand Up @@ -367,7 +367,7 @@ used the defaults for all these items.
Full, Recycle, Purged, Used, or Append is chosen).
:raw-latex:`
.. warning::
We strongly recommend against the use of \configdirective{Purge Oldest Volume as it can quite easily lead to loss of current backup
We strongly recommend against the use of \configdirective{Purge Oldest Volume} as it can quite easily lead to loss of current backup
data.}`

#. Give up and ask operator.
Expand Down Expand Up @@ -804,4 +804,4 @@ If you wish to reuse the tape by giving it a new name, use the
\warning{The :strong:`delete` command can be dangerous. Once it is
done, to recover the File records, you must either restore your database as it
was before the :strong:`delete` command or use the :ref:`bscan` utility program to
scan the tape and recreate the database entries.}
scan the tape and recreate the database entries.
10 changes: 4 additions & 6 deletions docs/manuals/en/new_main_reference/source/releasenotes.rst
Expand Up @@ -18,9 +18,9 @@ this document.
This chapter concentrates on things to do when updating an existing
Bareos installation.


:raw-latex:`
.. warning::
While all the source code is published on \elink{GitHub}{https://github.com/bareos/bareos}, the releases of packages on \verb|URL:http://download.bareos.org
While all the source code is published on \elink{GitHub}{https://github.com/bareos/bareos}, the releases of packages on \verb|URL:http://download.bareos.org}`
is limited to the initial versions of a major release. Later maintenance
releases are only published on https://download.bareos.com.\|

Expand Down Expand Up @@ -264,9 +264,7 @@ releases are only published on https://download.bareos.com.\|
\item The device spool size calculation when using secure erase was fixed.
\item :strong:`.bvfs_lsdirs` no longer shows empty directories from accurate jobs.
\begin{itemize}
\item
.. warning::
This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance.
\item \warning{This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance.}
%In Bareos 16.2.6 the SQL Query used by :strong:`.bvfs_lsdirs` was changed to not show
%empty directories from accurate jobs. It turned out that that the changed
%query causes performance issues when larger amounts of directories were backed up.\\
Expand Down Expand Up @@ -782,4 +780,4 @@ plan to ensure this in future version of Bareos.
This have been the initial release of Bareos.

Information about migrating from Bacula to Bareos are available at \elink{Howto upgrade from Bacula to Bareos}{http://www.bareos.org/en/HOWTO/articles/upgrade_bacula_bareos.html} and in section :ref:`compat-bacula`.
}

6 changes: 4 additions & 2 deletions docs/manuals/en/new_main_reference/source/rescue.rst
Expand Up @@ -183,7 +183,9 @@ you will get a bootable ISO image which can be burned onto a CD.



\warning{This will not create a Bareos backup on your system! You will have to do that by

.. warning::
This will not create a Bareos backup on your system! You will have to do that by
other means, e.g. by a regular Bareos backup schedule.
Also \command{rear mkbackup} will not create a backup.
In this configuration it will only create the rescue ISO
Expand Down Expand Up @@ -368,7 +370,7 @@ After that, ReaR will restore your bootloader. Recovery is complete.

This procedure has been confirmed to work by Ludovic Strappazon -- many
thanks!
}


Restoring a Bareos Server
-------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/manuals/en/new_main_reference/source/spooling.rst
Expand Up @@ -97,14 +97,16 @@ Additional Notes



\warning{Exclude your the spool directory from any backup,

.. warning::
Exclude your the spool directory from any backup,
otherwise, your job will write enormous amounts of data to the Volume, and
most probably terminate in error. This is because in attempting to backup the
spool file, the backup data will be written a second time to the spool file,
and so on ad infinitum.}

- Another advice is to always specify the
**Maximum Spool Size**:sup:`Sd`:sub:`Device`
:raw-latex:`\linkResourceDirective{Sd}{Device}{Maximum Spool Size`
so that your disk doesn’t completely fill up. In principle, data
spooling will properly detect a full disk, and despool data allowing
the job to continue. However, attribute spooling is not so kind to
Expand Down
7 changes: 2 additions & 5 deletions docs/manuals/en/new_main_reference/source/supportedoses.rst
Expand Up @@ -372,7 +372,7 @@ server-side.


.. warning::
The configuration file contains passwords and therefore must not be accessible for any users except admin users.
The configuration file contains passwords and therefore must not be accessible for any users except admin users.}

Restart bareos-fd after changing the configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -427,8 +427,5 @@ You can also manually start bareos-fd in debug mode by:




.. code-block:: sh
:caption: Start \bareosFd in debug mode
{commands}{Start \bareosFd in debug mode
sudo /usr/local/sbin/bareos-fd -f -d 100

0 comments on commit fd523cf

Please sign in to comment.