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.

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

docs: troubleshooting & debugging chapter improvements #1233

Conversation

bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Aug 18, 2022

This PR improve troubleshooting and debugging chapter by introducing dbg, debuginfo installation instruction, and core backtrace generation.

OP#4978

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 bruno-at-bareos force-pushed the dev/bruno/master/docs-troubleshooting-debugging-improvements branch from 3f70410 to 3815a45 Compare August 22, 2022 09:38
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/docs-troubleshooting-debugging-improvements branch from 3815a45 to 574161c Compare August 23, 2022 07:37
Copy link
Member

@pstorz pstorz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work!

docs/manuals/source/Appendix/Debugging.rst Outdated Show resolved Hide resolved
docs/manuals/source/Appendix/Troubleshooting.rst Outdated Show resolved Hide resolved
docs/manuals/source/Appendix/Troubleshooting.rst Outdated Show resolved Hide resolved
docs/manuals/source/Appendix/Debugging.rst Outdated Show resolved Hide resolved
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/docs-troubleshooting-debugging-improvements branch 2 times, most recently from badc0e5 to 7410d84 Compare August 29, 2022 13:30
@pstorz pstorz force-pushed the dev/bruno/master/docs-troubleshooting-debugging-improvements branch from 7410d84 to bdef1db Compare August 30, 2022 16:51
bruno-at-bareos and others added 3 commits August 30, 2022 18:54
- convert indexes and codeblock to Sphinx rest syntax.
- remove obsolete content (tcpwrapper,media volwrite integer).
- refresh examples.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- add section for debuging core file
- add section how to install dbg, debuginfo packages
- review and adapt index to Sphinx

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@pstorz pstorz force-pushed the dev/bruno/master/docs-troubleshooting-debugging-improvements branch from bdef1db to bf5a813 Compare August 30, 2022 16:54
@pstorz pstorz merged commit b884fbc into bareos:master Aug 30, 2022
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/docs-troubleshooting-debugging-improvements branch November 15, 2022 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This PR changes only documentation requires backport to 21
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants