added limitation command

bareos · Jan 25, 2016 · a4a6c38 · a4a6c38
1 parent 92c5110
commit a4a6c38
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 12 deletions.
diff --git a/manuals/en/main/bareos-manual-main-reference.tex b/manuals/en/main/bareos-manual-main-reference.tex
@@ -61,6 +61,7 @@
 \usepackage{xspace}
 %\usepackage{svg}
 %\usepackage{import}
+%\usepackage{xparse}
 
 \usepackage{bareos}
 

diff --git a/manuals/en/main/bareos.sty b/manuals/en/main/bareos.sty
@@ -220,6 +220,34 @@ Version $>=$ #3%
 }
 }
 
+
+\makeatletter
+\newcommand{\limitation}{%
+\@ifstar{%
+\limitationStar
+}{%
+\limitationNostar
+}%
+}
+\makeatother
+
+\newcommand{\limitationStar}[3]{%
+\paragraph{#2.}
+%\limitationCommon{#1}{#2}{#3}
+#3
+\index[general]{Limitation!#1!#2}%
+\index[general]{#1!Limitation!#2}%
+}
+
+\newcommand{\limitationNostar}[3]{%
+\paragraph{Limitation: #1: #2.}
+%\limitationCommon{#1}{#2}{#3}
+#3
+\index[general]{Limitation!#1!#2}%
+\index[general]{#1!Limitation!#2}%
+}
+
+
 % #1 backend name (Rados)
 % [ #2: backend category (CEPH Object Store) ]
 \newcommand{\sdBackend}[2]{%

diff --git a/manuals/en/main/coverpage.tex b/manuals/en/main/coverpage.tex
@@ -16,7 +16,7 @@
       \vspace{0.2in}
       Copyright {\copyright} 1999-2012, Free Software Foundation Europe e.V. \\
       Copyright {\copyright} 2010-2012, Planets Communications B.V. \\
-      Copyright {\copyright} 2013-2015, Bareos GmbH \& Co. KG \\
+      Copyright {\copyright} 2013-2016, Bareos GmbH \& Co. KG \\
       Bareos {\textregistered} is a registered trademark of Bareos GmbH \& Co KG.\\
       Bacula {\textregistered} is a registered trademark of Kern Sibbald.\\
       \vspace{0.2in}

diff --git a/manuals/en/main/ndmp.tex b/manuals/en/main/ndmp.tex
@@ -927,17 +927,20 @@ \subsection{NDMP Job limitations when scanning in volumes}
 
 For NDMP jobs, all data is stored into a single big file. The file and directory information (File History in NDMP Terms) is stored as hardlinks to this big file.
 
+\limitation*{NDMP}{File information are not available in the Bareos backup stream}{%
 As hardlink information is only stored in the Bareos database, but not int the backup stream itself, it is not possible to recover the file history information from the NDMP stream with \command{bscan}.
 
 As storing the database dump for disaster recovery and storing the bootstrap file offsite is recommended  anyway (see \nameref{sec:before-disaster}), this should be not a big problem in correctly setup environments.
 
 For the same reason, the information about the number of files of a job (e.g. JobFiles with \bcommand{list}{jobs} command) is limited to the number of NDMP backup files in copied jobs.
-
+}
 
 \subsection{Single file restore on incremental backups}
 
+\limitation*{NDMP}{No single file restore on merged backups}{%
 Unfortunately, it is currently (bareos-15.2.2) not possible to restore a chain of Full and Incremental backups at once.
 The workaround for that problem is to restore the full backup and each incremental each in a single restore operation.
+}
 
 \subsection{Restore always transfers the full main backup file to the Primary Storage System}
 

diff --git a/manuals/en/main/plugins-vmware-plugin.tex b/manuals/en/main/plugins-vmware-plugin.tex
@@ -1,7 +1,7 @@
 \subsection{VMware Plugin}
 \label{VMwarePlugin}
 \index[general]{Plugin!VMware}
-\index[general]{VMware!Plugin}
+\index[general]{VMware Plugin}
 
 The \vmware\ Plugin can be
 used for agentless backups of virtual machines running on
@@ -16,15 +16,17 @@ \subsubsection{Status}
 The Plugin can do full, differential and incremental backup and restore of VM disks.
 
 Current limitations amongst others are:
-\begin{itemize}
-\item it is not yet possible to exclude normal (dependent) VM disks from backups,
-  but independent disks are excluded implicitly because they are not affected
-  by snapshots which are required for CBT based backup.
-\item the VM configuration is not yet backed up, so that it is not yet
-  possible to recreate a completely deleted VM
-\item the above implies that restore is still only possible to the same existing
-  VM with exising virtual disks
-\end{itemize}
+
+\limitation*{VMware Plugin}{Normal VM disks can not be excluded from the backup}{%
+    It is not yet possible to exclude normal (dependent) VM disks from backups.
+    However, independent disks are excluded implicitly because they are not affected
+    by snapshots which are required for CBT based backup.}
+
+\limitation*{VMware Plugin}{VM configuration is not backed up}{%
+    The VM configuration is not yet (bareos-15.2.2) backed up, so that it is not yet possible to recreate a completely deleted VM.}
+
+\limitation*{VMware Plugin}{Restore can only be done to the same VM}{%
+    The restore is only possible to the same existing VM with existing virtual disks.}
 
 \subsubsection{Requirements}
 As the Plugin is based on the \vSphere\ Storage APIs for Data Protection,