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

Document stellar-core-debug-info #4545

Closed
marta-lokhova opened this issue Nov 19, 2024 · 1 comment · Fixed by #4553
Closed

Document stellar-core-debug-info #4545

marta-lokhova opened this issue Nov 19, 2024 · 1 comment · Fixed by #4553
Assignees
@SirTyson
Labels
docs issue/PR that affects documentation

Comments

@marta-lokhova
Copy link
Contributor

marta-lokhova commented Nov 19, 2024 •
edited
Loading

Including documentation in the repo as well as stellar-docs
@marta-lokhova marta-lokhova added the docs issue/PR that affects documentation label Nov 19, 2024
@marta-lokhova
Copy link
Contributor Author

@SirTyson would you like to tackle this one?

@SirTyson SirTyson self-assigned this Nov 21, 2024
@SirTyson SirTyson mentioned this issue Nov 21, 2024
Merged
6 tasks
github-merge-queue bot pushed a commit that referenced this issue Nov 25, 2024
@anupsdf
Improves stellar-core-debug-info script and adds docs (#4553)
7f54c88 
# Description

Resolves #4545

This PR updates documentation regarding the `stellar-core-debug-info`.

Additionally, while helping people debug nodes, the script was difficult
to use and had many default values specific only to SDF infrastructure.
I've updated the script to be easier to use. Specifically, it requires
an output directory argument, and creates the directory automatically if
it does not exist. The script also automatically detects the
stellar-core executable path and config via the `stellar-core.service`
file. Finally, I've added additional error checking around
`offline-info` and better path resolution, which previously was buggy.

# Checklist
- [x] Reviewed the
[contributing](https://github.com/stellar/stellar-core/blob/master/CONTRIBUTING.md#submitting-changes)
document
- [x] Rebased on top of master (no merge commits)
- [x] Ran `clang-format` v8.0.0 (via `make format` or the Visual Studio
extension)
- [x] Compiles
- [x] Ran all tests
- [ ] If change impacts performance, include supporting evidence per the
[performance
document](https://github.com/stellar/stellar-core/blob/master/performance-eval/performance-eval.md)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SirTyson SirTyson

Labels
docs issue/PR that affects documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improves stellar-core-debug-info script and adds docs SirTyson/stellar-core
2 participants
@marta-lokhova @SirTyson