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

Improve dump FAQ #44714

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve dump FAQ #44714

wants to merge 1 commit into from

Conversation

noahfalk
Copy link
Member

@noahfalk noahfalk commented Feb 7, 2025

Fixes dotnet/diagnostics#4375

  • The previous guidance for diagnosing dump permission issues did not mention the interaction between setcap and ptrace. I added that information as well as a more complete description of the ptrace access checking.

  • I replaced faq-dumps.yml with dump-faq.md. The yml file included markdown style links but that content was not properly rendered in the html page. Maybe there was a way to make that work as-is but it seemed simpler to use markdown similar to all the other pages in this part of the docs. I redirected links to the new page but left the old .yml page for now in case there were external direct links to it.

  • There was no link to the FAQ in the TOC so I added one.

  • I made some minor edits to the dump overview page that IMO improved clarity and flow of the text.


Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/dotnet-dump.md Dump collection and analysis utility (dotnet-dump)
docs/core/diagnostics/dumps-faq.md .NET dumps FAQ
docs/core/diagnostics/dumps.md Dumps
docs/navigate/tools-diagnostics/toc.yml docs/navigate/tools-diagnostics/toc

Fixes dotnet/diagnostics#4375

- The previous guidance for diagnosing dump permission issues did not mention the interaction between setcap and ptrace.
I added that information as well as a more complete description of the ptrace access checking.

- I replaced faq-dumps.yml with dump-faq.md. The yml file included markdown style links but that content was not properly
rendered in the html page. Maybe there was a way to make that work as-is but it seemed simpler to use markdown similar
to all the other pages in this part of the docs. I redirected links to the new page but left the old .yml page for now in case
there were external direct links to it.

- There was no link to the FAQ in the TOC so I added one.

- I made some minor edits to the dump overview page that IMO improved clarity and flow of the text.
@noahfalk noahfalk marked this pull request as ready for review February 7, 2025 08:35
@noahfalk noahfalk requested review from tommcdon and a team as code owners February 7, 2025 08:35
@noahfalk
Copy link
Member Author

noahfalk commented Feb 7, 2025

@hoyosjs - could you take a look?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dotnet-dump not working when process run as user
1 participant