Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarifies Sphinx bareos-extensions parallel_read_safe status #1137

Merged
merged 2 commits into from
Mar 31, 2022
Merged

docs: clarifies Sphinx bareos-extensions parallel_read_safe status #1137

merged 2 commits into from
Mar 31, 2022

Conversation

bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Mar 24, 2022 •
edited by arogge

In this PR we clarify the status of our sphinx extension about parallel_read_status (False) and parallel_write_status (True default)

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted
  • If backport: add original PR number and target branch at top of this file: Backport of PR#000 to bareos-2x
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
  • bareos-check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing

@bruno-at-bareos
docs: bareos sphinx extension clarify status of parallel_read_safe.
25f8bcc 
- 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>
@bruno-at-bareos
update CHANGELOG.md
baa7c01 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos bruno-at-bareos added the documentation This PR changes only documentation label Mar 24, 2022
@arogge arogge merged commit b3deab7 into bareos:master Mar 31, 2022
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/docs_sphinx_bareos-ext_warnings branch March 31, 2022 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arogge arogge arogge approved these changes

Assignees

@arogge arogge

Labels
documentation This PR changes only documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bruno-at-bareos @arogge