Skip to content

Commit

Permalink
docs: bareos sphinx extension clarify status of parallel_read_safe.
Browse files Browse the repository at this point in the history
- Set explicit parallel_read_safe to False
- Set explicit parallel_write_safe to True (default)

References: https://www.sphinx-doc.org/en/master/extdev/#extension-metadata

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
  • Loading branch information
bruno-at-bareos committed Mar 24, 2022
1 parent 2647f86 commit 25f8bcc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions docs/manuals/source/_extensions/bareos-ext.py
@@ -1,6 +1,6 @@
# BAREOS - Backup Archiving REcovery Open Sourced
#
# Copyright (C) 2019-2021 Bareos GmbH & Co. KG
# Copyright (C) 2019-2022 Bareos GmbH & Co. KG
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of version three of the GNU Affero General Public
Expand Down Expand Up @@ -708,4 +708,8 @@ def setup(app):
)

# identifies the version of our extension
return {"version": "0.4"}
return {
"version": "0.4",
"parallel_read_safe": False,
"parallel_write_safe": True
}
8 changes: 6 additions & 2 deletions docs/manuals/source/_extensions/limitation.py
@@ -1,6 +1,6 @@
# BAREOS - Backup Archiving REcovery Open Sourced
#
# Copyright (C) 2019-2020 Bareos GmbH & Co. KG
# Copyright (C) 2019-2022 Bareos GmbH & Co. KG
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of version three of the GNU Affero General Public
Expand Down Expand Up @@ -132,4 +132,8 @@ def setup(app):
app.add_directive("limitation", LimitationDirective)

# identifies the version of our extension
return {"version": "0.2"}
return {
"version": "0.2",
"parallel_read_safe": False,
"parallel_write_safe": True
}

0 comments on commit 25f8bcc

Please sign in to comment.