Skip to content

Commit

Permalink
docs: (Sphinx) replace links with files copied from main/
Browse files Browse the repository at this point in the history
This is required, as sphinx-versioning can't cope with links.
  • Loading branch information
joergsteffens committed Mar 7, 2019
1 parent 71eb0fb commit 8b48304
Show file tree
Hide file tree
Showing 65 changed files with 8,237 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/manuals/en/new_main_reference/Makefile
Expand Up @@ -19,7 +19,7 @@ BUILDDIR = BareosMainReference
#nothing:

# Put it first so that "make" without argument is like "make help".
all: $(GENERATED) pre latexpand split pandoc post1 post2 presphinx sphinx
all: $(GENERATED) copy pre latexpand split pandoc post1 post2 presphinx sphinx

autogenerated/bareos-dir-*.rst.inc: autogenerated/bareos-dir-config-schema.json
# generates all director-resource files
Expand All @@ -43,6 +43,16 @@ autogenerated/bareos-tray-monitor-*.rst.inc: autogenerated/bareos-tray-monitor-c

autogenerated: $(GENERATED)

copy:
# IN: ../main/**.tex
# OUT: source/**
mkdir -p source/include/config/
cp -a ../main/*.txt source/include/
cp -a ../main/config/*.conf source/include/config/
mkdir -p source/autogenerated/
cp -a ../main/autogenerated/*-resource-*-description.rst.inc source/autogenerated/


pre:
# IN: ../main/**.tex
# OUT: build/pre/**.tex
Expand Down
@@ -0,0 +1,203 @@
.. config:option:: dir/catalog/Address

:type: STRING

*This directive is an alias.*

.. include:: /config-directive-description/dir-catalog-Address.rst.inc



.. config:option:: dir/catalog/DbAddress

:type: STRING

.. include:: /config-directive-description/dir-catalog-DbAddress.rst.inc



.. config:option:: dir/catalog/DbDriver

:required: True
:type: STRING

.. include:: /config-directive-description/dir-catalog-DbDriver.rst.inc



.. config:option:: dir/catalog/DbName

:required: True
:type: STRING

.. include:: /config-directive-description/dir-catalog-DbName.rst.inc



.. config:option:: dir/catalog/DbPassword

:type: AUTOPASSWORD

.. include:: /config-directive-description/dir-catalog-DbPassword.rst.inc



.. config:option:: dir/catalog/DbPort

:type: PINT32

.. include:: /config-directive-description/dir-catalog-DbPort.rst.inc



.. config:option:: dir/catalog/DbSocket

:type: STRING

.. include:: /config-directive-description/dir-catalog-DbSocket.rst.inc



.. config:option:: dir/catalog/DbUser

:type: STRING

.. include:: /config-directive-description/dir-catalog-DbUser.rst.inc



.. config:option:: dir/catalog/Description

:type: STRING

.. include:: /config-directive-description/dir-catalog-Description.rst.inc



.. config:option:: dir/catalog/DisableBatchInsert

:type: BOOLEAN
:default: no

.. include:: /config-directive-description/dir-catalog-DisableBatchInsert.rst.inc



.. config:option:: dir/catalog/ExitOnFatal

:type: BOOLEAN
:default: no
:version: 15.1.0

Make any fatal error in the connection to the database exit the program

.. include:: /config-directive-description/dir-catalog-ExitOnFatal.rst.inc



.. config:option:: dir/catalog/IdleTimeout

:type: PINT32
:default: 30

This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the idle time after which a database pool should be shrinked.

.. include:: /config-directive-description/dir-catalog-IdleTimeout.rst.inc



.. config:option:: dir/catalog/IncConnections

:type: PINT32
:default: 1

This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the number of connections to add to a database pool when not enough connections are available on the pool anymore.

.. include:: /config-directive-description/dir-catalog-IncConnections.rst.inc



.. config:option:: dir/catalog/MaxConnections

:type: PINT32
:default: 5

This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the maximum number of connections to a database to keep in this database pool.

.. include:: /config-directive-description/dir-catalog-MaxConnections.rst.inc



.. config:option:: dir/catalog/MinConnections

:type: PINT32
:default: 1

This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the minimum number of connections to a database to keep in this database pool.

.. include:: /config-directive-description/dir-catalog-MinConnections.rst.inc



.. config:option:: dir/catalog/MultipleConnections

:type: BIT

.. include:: /config-directive-description/dir-catalog-MultipleConnections.rst.inc



.. config:option:: dir/catalog/Name

:required: True
:type: NAME

The name of the resource.

.. include:: /config-directive-description/dir-catalog-Name.rst.inc



.. config:option:: dir/catalog/Password

:type: AUTOPASSWORD

*This directive is an alias.*

.. include:: /config-directive-description/dir-catalog-Password.rst.inc



.. config:option:: dir/catalog/Reconnect

:type: BOOLEAN
:default: no
:version: 15.1.0

Try to reconnect a database connection when its dropped

.. include:: /config-directive-description/dir-catalog-Reconnect.rst.inc



.. config:option:: dir/catalog/User

:type: STRING

*This directive is an alias.*

.. include:: /config-directive-description/dir-catalog-User.rst.inc



.. config:option:: dir/catalog/ValidateTimeout

:type: PINT32
:default: 120

This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the validation timeout after which the database connection is polled to see if its still alive.

.. include:: /config-directive-description/dir-catalog-ValidateTimeout.rst.inc



0 comments on commit 8b48304

Please sign in to comment.