Skip to content

Improvements to core dumps section in developer documentation (and some smaller stuff) #10418

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

Merged
merged 5 commits into from
May 5, 2025

Conversation

jschmidt-icinga
Copy link
Contributor

Core Dumps

Updated and added more information to set up generating core dumps, touching and expanding on systemd's coredumpctl, Ubuntu's apport and the conventional method.

This fixes #8714.

Unity Builds

Rephrased some sentences to make them more understandably and avoid awkward claims like Icinga 'inventing' unity builds.

Preferred Editors

Removed Atom and added Emacs. 😁

Typos

Also fixed a few typos and capitalization errors (maybe added a few too).

I'm happy to incorporate any further suggestions.

@jschmidt-icinga jschmidt-icinga force-pushed the jschmidt/doc-impr-unity-builds-core-dumps branch 2 times, most recently from dbc84a9 to f02d06b Compare April 24, 2025 07:28
@jschmidt-icinga
Copy link
Contributor Author

Fyi: I've pushed a full rebase with the added changes so the base of the branch gets past the commit on master adding me to the AUTHORS file.

Copy link
Contributor

@julianbrost julianbrost left a comment

Choose a reason for hiding this comment

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

You're adding some quite long lines there, so can you please wrap them? There isn't really a strict limit for this file and also it's not perfectly consistent at the moment. For me it's "I won't complain if it adheres to a reasonable limit with reasonable being at most 120 characters".

@jschmidt-icinga
Copy link
Contributor Author

For me it's "I won't complain if it adheres to a reasonable limit with reasonable being at most 120 characters".

Personally I'd prefer letting the editor handle line breaks in regular text (i.e. not code or code comments), but to maintain consistency I'll break it down to a column-width of 100-120 characters.

Corrected one instance where `CMake` was spelled as `cmake` despite the rest
of the docs using the first spelling.
Atom is already dead.

But Emacs will outlast human civilization.
You can only 'recognize' something you already know and 'another thing',
while not necessarily wrong does not seem right here when there isn't a
'first thing' to notice.
We didn't really 'invent' unity builds, more like adopted them, since
this is a common practice.

Also added a reference to the actual CMake variable in question instead
of just alluding to it
@jschmidt-icinga jschmidt-icinga force-pushed the jschmidt/doc-impr-unity-builds-core-dumps branch from f02d06b to 18eb679 Compare April 28, 2025 11:39
@jschmidt-icinga
Copy link
Contributor Author

@julianbrost I've pushed a new version with the lines broken to ~80 columns and SIGABRT mentioned.

@jschmidt-icinga jschmidt-icinga force-pushed the jschmidt/doc-impr-unity-builds-core-dumps branch from 18eb679 to c1bca3e Compare April 30, 2025 11:23
@jschmidt-icinga
Copy link
Contributor Author

@julianbrost I've pushed a new version with the requested changes.

julianbrost
julianbrost previously approved these changes Apr 30, 2025
@julianbrost
Copy link
Contributor

@oxzi I heard you like documentation, do you want to also have a look? 😅

@julianbrost julianbrost requested a review from oxzi April 30, 2025 13:01
Copy link
Member

@oxzi oxzi left a comment

Choose a reason for hiding this comment

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

Very well written, thanks a lot! I have only added one note, please feel free to either address it or decline it, as you like.

@jschmidt-icinga jschmidt-icinga force-pushed the jschmidt/doc-impr-unity-builds-core-dumps branch from c1bca3e to 9350e3a Compare May 5, 2025 08:22
@jschmidt-icinga jschmidt-icinga force-pushed the jschmidt/doc-impr-unity-builds-core-dumps branch from 9350e3a to 88b2831 Compare May 5, 2025 08:23
Copy link
Member

@oxzi oxzi left a comment

Choose a reason for hiding this comment

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

Thanks again!

@julianbrost
Copy link
Contributor

PR doesn't touch the code, the failing pipeline would be fixed by #10430 but I see little value in rebasing here just to rebuild the unchanged code, hence I'll force-merge.

@julianbrost julianbrost merged commit 33824c2 into master May 5, 2025
44 of 46 checks passed
@julianbrost julianbrost deleted the jschmidt/doc-impr-unity-builds-core-dumps branch May 5, 2025 15:29
@oxzi oxzi added this to the 2.15.0 milestone May 6, 2025
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.

Update documentation on core dumps
3 participants