Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge branch 'dev/joergs/bareos-18.2/doc' into bareos-18.2
  • Loading branch information
pstorz committed Jan 3, 2019
2 parents f3e9084 + f25ff26 commit 30ec594
Show file tree
Hide file tree
Showing 8 changed files with 1,224 additions and 49 deletions.
32 changes: 15 additions & 17 deletions docs/manuals/en/main/ndmp.tex
Expand Up @@ -179,24 +179,22 @@ \section{NDMP Backup in Bareos}
\begin{center}
\begin{tabular}{l | c | c}
\hline
& \NdmpBareos & \NdmpNative \\
& \NdmpBareos & \NdmpNative \\
\hline
\DataManagementAgent & \bareosDir & \bareosDir \\
\TapeAgent & \bareosSd & external \\
requires external \TapeAgent & & \bcheckmark \\
backup to tape (and VTL) & \bcheckmark & \bcheckmark \\
backup to other \linkResourceDirective{Sd}{Device}{Device Type}
& \bcheckmark & \\
2-way backup & & \bcheckmark \\
3-way backup & \bcheckmark & untested \\
Full Backups & \bcheckmark & \bcheckmark \\
Differential Backups & \bcheckmark & \bcheckmark \\
Incremental Backups & \cmlink{sec:NdmpBackupLevel} (8) & \cmlink{sec:NdmpBackupLevel} (8)\\
Single File Restore & \bcheckmark & \bcheckmark \\
DAR & & \bcheckmark \\
DDAR & & \bcheckmark \\
\ilink{Copy and Migration jobs}{MigrationChapter}
& \bcheckmark & \\
\DataManagementAgent & \bareosDir & \bareosDir \\
\TapeAgent & \bareosSd & external \\
requires external \TapeAgent & & \bcheckmark \\
backup to tape (and VTL) & \bcheckmark & \bcheckmark \\
backup to other \linkResourceDirective{Sd}{Device}{Device Type} & \bcheckmark & \\
2-way backup & & \bcheckmark \\
3-way backup & \bcheckmark & untested \\
Full Backups & \bcheckmark & \bcheckmark \\
Differential Backups & \bcheckmark & \bcheckmark \\
Incremental Backups & \cmlink{sec:NdmpBackupLevel} (8) & \cmlink{sec:NdmpBackupLevel} (8)\\
Single File Restore & \bcheckmark & \bcheckmark \\
DAR & & \bcheckmark \\
DDAR & & \bcheckmark \\
\ilink{Copy and Migration jobs}{MigrationChapter} & \bcheckmark & \\
\hline
\end{tabular}
\end{center}
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/en/main/programs.tex
Expand Up @@ -1150,7 +1150,7 @@ \subsubsection{btape Commands}
\item[\texttt{file\_size=n}] Specify the \linkResourceDirective{Sd}{Device}{Maximum File Size}
for this test. This counter is in GB.
\item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
of data should be greater than your memory ($file\_size*nb\_file$).
of data should be greater than your memory (file\_size $*$ nb\_file).
\item[\texttt{skip\_zero}] This flag permits to skip tests with constant data.
\item[\texttt{skip\_random}] This flag permits to skip tests with random data.
\item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/en/main/win32.tex
Expand Up @@ -595,13 +595,13 @@ \subsection{Windows Service}
This is configured in the Registry at

\begin{itemize}
\item \path|Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Bareos-fd|
\item \registrykey{HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Bareos-fd}
\end{itemize}

You can use the command \command{regedit} to modify the settings.

E.g. to always start Bareos in debug mode,
modify \path|Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Bareos-fd| \path|ImagePath|
modify \registrykey{HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Bareos-fd} \path|ImagePath|
from

{
Expand Down
14 changes: 11 additions & 3 deletions docs/manuals/en/new_main_reference/Makefile
Expand Up @@ -10,12 +10,20 @@ BUILDDIR = BareosMainReference


# Put it first so that "make" without argument is like "make help".
all:
all: convert sphinx

convert:
./convert_all_tex_files_to_rst.sh

sphinx:
#sphinx-versioning -l source/conf.py build docs/manuals/en/new_main_reference/source/ docs/manuals/en/new_main_reference/BareosMainReference/
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
#@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

postpandoc:
./convert_all_tex_files_to_rst.sh postpandoc
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Expand All @@ -27,5 +35,5 @@ check:

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
#%: Makefile
# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
36 changes: 29 additions & 7 deletions docs/manuals/en/new_main_reference/convert_all_tex_files_to_rst.sh
@@ -1,25 +1,47 @@
#!/bin/bash
set -x

#set -x

ORIGIN_DIR="../main/"
WORK_DIR="./build/"
TARGET_DIR="./source/"

for destfile in `cat destfiles.txt | grep -v ^#`;
do
PHASE=${1:-ALL}
FILES=${2:-$(cat destfiles.txt | grep -v ^#)}

for destfile in $FILES; do
file=`echo $destfile | sed 's#.*/##g'`
chapterdir=`echo $destfile | sed 's#/.*##g'`
filebase=`basename $destfile .tex`

mkdir -p ${WORK_DIR}${chapterdir}
mkdir -p ${TARGET_DIR}${chapterdir}

if [ "${chapterdir}" != "developers" ]; then

./pre_conversion_changes.sh ${ORIGIN_DIR}${file} ${TARGET_DIR}${destfile};
if [ $PHASE == "ALL" ] || [ $PHASE == "prepandoc" ]; then
printf "%-50s (%s)\n" "$destfile" "prepandoc"
./pre_conversion_changes.sh ${ORIGIN_DIR}${file} ${WORK_DIR}${destfile}
fi

pandoc --verbose --columns=500 -f latex+raw_tex -t rst ${TARGET_DIR}${destfile} -o ${TARGET_DIR}${chapterdir}/${filebase}.rst || exit "could not convert file $file"
if [ $PHASE == "ALL" ] || [ $PHASE == "pandoc" ]; then
printf "%-50s (%s)\n" "$destfile" "pandoc"
pandoc --verbose --columns=500 -f latex+raw_tex -t rst ${WORK_DIR}${destfile} -o ${WORK_DIR}${chapterdir}/${filebase}.rst || exit "could not convert file ${WORK_DIR}${destfile}"
#pandoc --verbose --columns=500 -f latex+raw_tex -t rst --filter latex-scan.py ${TARGET_DIR}${destfile} -o ${TARGET_DIR}${chapterdir}/${filebase}.rst || exit "could not convert file $file"
fi

./post_conversion_changes.sh ${TARGET_DIR}${chapterdir}/${filebase}.rst
if [ $PHASE == "ALL" ] || [ $PHASE == "postpandoc" ]; then
printf "%-50s (%s)\n" "$destfile" "postpandoc"
# ./post_conversion_changes.sh ${TARGET_DIR}${chapterdir}/${filebase}.rst
printf "%s\n" ".. ATTENTION do not edit this file manually." > ${TARGET_DIR}${chapterdir}/${filebase}.rst
printf "%s\n\n" " It was automatically converted from the corresponding .tex file" >> ${TARGET_DIR}${chapterdir}/${filebase}.rst
cat ${WORK_DIR}${chapterdir}/${filebase}.rst | ./latex-scan.py --standalone >> ${TARGET_DIR}${chapterdir}/${filebase}.rst 2>${WORK_DIR}${chapterdir}/${filebase}.latex-scan.log || exit "failed to post convert ${WORK_DIR}${chapterdir}/${filebase}.rst"
fi
else
# developers files are only copied over
echo "not doing: cp ../developers/source/${file} ${TARGET_DIR}${chapterdir}"
if [ $PHASE == "ALL" ]; then
#cp ../developers/source/${file} ${TARGET_DIR}${chapterdir}
echo "not doing: cp ../developers/source/${file} ${TARGET_DIR}${chapterdir}"
fi
fi
done

0 comments on commit 30ec594

Please sign in to comment.