Skip to content
This repository has been archived by the owner on Mar 19, 2021. It is now read-only.

Commit

Permalink
use autodoc also for to describe directives
Browse files Browse the repository at this point in the history
done for Director/Director/*,
for the others resources, it is only prepared.
  • Loading branch information
joergsteffens committed Oct 15, 2014
1 parent d9e3d80 commit b120c62
Show file tree
Hide file tree
Showing 9 changed files with 313 additions and 262 deletions.
5 changes: 4 additions & 1 deletion manuals/en/main/Makefile
Expand Up @@ -81,7 +81,10 @@ autogenerated/*.tex: autogenerated/bareos-dir-config-schema.json
$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-dir-config-schema.json

check: bareos-manual-main-reference.pdf
@if ! grep "LaTeX Warning: Hyper reference .* undefined on input\|LaTeX Warning: There were undefined references." $(LOG); then echo "CHECK: OK"; true; else echo "CHECK: FAILED: undefined references"; false; fi
@# hyperlink: multiline: pdfTeX warning .* has been reference$d but does not exist
@# TODO: add \|pdfTeX warning .* has been reference
@# defDirective multiline: Warning: defDirective{Dir}{Director}{PluginNames} has no matching resourceDirec$tive and will be ignored.
@if ! grep "LaTeX Warning: Hyper reference .* undefined on input\|LaTeX Warning: There were undefined references.\|Warning: defDirective" $(LOG); then echo "CHECK: OK"; true; else echo "CHECK: FAILED: undefined references"; false; fi

clean:
rm -f *.4ct *.4dx *.4ix *.4tc *.aux *.dvi *.htidx *.htind *.idx *.log *.out *.pdf *.toc *.idv *.lg *.tmp *.xref html/* bareos-manual-main-reference.html bareos-manual-main-reference.css
Expand Down
6 changes: 3 additions & 3 deletions manuals/en/main/ansi-labels.tex
Expand Up @@ -33,19 +33,19 @@ \section{Tape Labels: ANSI or IBM}
\subsection{Director Pool Directive}

\begin{description}
\xdirective{dir}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{required}{Bareos}{}{This directive is implemented in the Director Pool resource and in the SD Device
\xdirective{dir}{}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{required}{Bareos}{}{This directive is implemented in the Director Pool resource and in the SD Device
resource. If it is specified in the SD Device resource, it will take
precedence over the value passed from the Director to the SD.}
\end{description}

\subsection{Storage Daemon Device Directives}

\begin{description}
\xdirective{sd}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{}{}{}{This directive is implemented in the Director Pool resource and in the SD Device
\xdirective{dir}{}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{}{}{}{This directive is implemented in the Director Pool resource and in the SD Device
resource. If it is specified in the the SD Device resource, it will take
precedence over the value passed from the Director to the SD.}

\xdirective{sd}{Check Label}{yes{\textbar}no}{}{no}{}{This directive is implemented in the the SD Device resource. If you intend
\xdirective{dir}{}{Check Label}{yes{\textbar}no}{}{no}{}{This directive is implemented in the the SD Device resource. If you intend
to read ANSI or IBM labels, this *must* be set. Even if the volume is
not ANSI labeled, you can set this to yes, and Bareos will check the
label type. Without this directive set to yes, Bareos will assume that
Expand Down
2 changes: 1 addition & 1 deletion manuals/en/main/autochangers.tex
Expand Up @@ -265,7 +265,7 @@ \section{Device Configuration Records}

\begin{description}

\xdirective{sd}{Autochanger}{yes {\textbar} no}{}{no}{}{%
\xdirective{dir}{}{Autochanger}{yes {\textbar} no}{}{no}{}{%
The \configdirective{Autochanger} record specifies if the current device belongs to an
autochanger ressource.
}
Expand Down

0 comments on commit b120c62

Please sign in to comment.