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: better explain how core dump files can be obtained #28826

Merged
merged 1 commit into from
May 21, 2024

Conversation

wookayin
Copy link
Member

@wookayin wookayin commented May 17, 2024

Problem: Docs about how to obtain backtraces on Linux is not very
beginner-friendly; some users used to have difficulties in getting
stacktrace against Nvim crash.

For instance, the core dump file might not appear in the current
directory on Ubuntu systems with apport, and the current docs do not
fully cover such cases.

Solution: Add more hints about where core dump files can be found. For
example, on Ubuntu where apport is managing core dump files, users would
want to find them in /var/lib/apport/coredump.

Ref: https://stackoverflow.com/questions/2065912/core-dumped-but-core-file-is-not-in-the-current-directory (also in the vimdoc)

Also, polish the docs a bit more.

runtime/doc/dev_tools.txt Outdated Show resolved Hide resolved
@github-actions github-actions bot requested a review from clason May 17, 2024 23:44
@wookayin wookayin force-pushed the docs-stacktrace branch 3 times, most recently from a9d78b6 to 1056d44 Compare May 18, 2024 00:51
Problem: Docs about how to obtain backtraces on Linux is not very
beginner-friendly; some users used to have difficulties in getting
stacktrace against Nvim crash.

For instance, the `core` dump file might not appear in the current
directory on Ubuntu systems with apport, and the current docs do not
fully cover such cases.

Solution: Add more hints about where core dump files can be found. For
example, on Ubuntu where apport is managing core dump files, users would
want to find them in `/var/lib/apport/coredump`.

Also, polish the docs a bit more.
@justinmk justinmk merged commit 56b7a18 into neovim:master May 21, 2024
29 checks passed
@wookayin wookayin deleted the docs-stacktrace branch May 21, 2024 17:11
huangyingw pushed a commit to huangyingw/neovim that referenced this pull request May 31, 2024
Problem: Docs about how to obtain backtraces on Linux is not very
beginner-friendly; some users used to have difficulties in getting
stacktrace against Nvim crash.

For instance, the `core` dump file might not appear in the current
directory on Ubuntu systems with apport, and the current docs do not
fully cover such cases.

Solution: Add more hints about where core dump files can be found. For
example, on Ubuntu where apport is managing core dump files, users would
want to find them in `/var/lib/apport/coredump`.
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.

None yet

5 participants