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

gh-101100: Fix Sphinx warnings in library/faulthandler.rst #118353

Merged
merged 1 commit into from
Apr 28, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 27, 2024

Fix 13 warnings:

library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGSEGV
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGFPE
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGABRT
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGBUS
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGILL
library/faulthandler.rst:18: WARNING: c:func reference target not found: sigaltstack
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGSEGV
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGFPE
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGABRT
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGBUS
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGILL
library/faulthandler.rst:107: WARNING: c:func reference target not found: _exit
library/faulthandler.rst:107: WARNING: c:func reference target not found: _exit

Link the SIG* py:consts to the signal module, and add ! to the c:funcs which I don't think need documenting.


📚 Documentation preview 📚: https://cpython-previews--118353.org.readthedocs.build/

@AlexWaygood
Copy link
Member

PR title is interesting 👀

@hugovk hugovk changed the title gh-101100: Add GitHub Action to ensure code changes include tests gh-101100: Fix Sphinx warnings in library/faulthandler.rst Apr 27, 2024
@hugovk
Copy link
Member Author

hugovk commented Apr 27, 2024

Haha, it was a mistake, corrected now!

I had some extra stuff on main, was playing around with https://github.com/brettcannon/check-for-changed-files/ to try python/core-workflow#480 (didn't get it working...). Rebased my branch before creating the PR but it kept the old default title :)

@hugovk hugovk changed the title gh-101100: Fix Sphinx warnings in library/faulthandler.rst gh-101100: Fix Sphinx warnings in library/faulthandler.rst Apr 27, 2024
Comment on lines +111 to +112
:c:func:`!_exit` with status=1 after dumping the tracebacks. (Note
:c:func:`!_exit` exits the process immediately, which means it doesn't do any
Copy link
Member

Choose a reason for hiding this comment

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

Is this the same as https://docs.python.org/3/library/os.html#os._exit? Should this link to that, maybe?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think so, it's calling the C one from unistd.h:

# include <unistd.h> // _exit()

if (thread.exit)
_exit(1);

Copy link
Member

Choose a reason for hiding this comment

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

I think os._exit is just a very thin wrapper around the C one:

cpython/Modules/posixmodule.c

Lines 6613 to 6619 in e0ab642

static PyObject *
os__exit_impl(PyObject *module, int status)
/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
{
_exit(status);
return NULL; /* Make gcc -Wall happy */
}

But yes, good point, they're not exactly the same!

@hugovk hugovk merged commit 33c6cf3 into python:main Apr 28, 2024
36 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-faulthandler branch April 28, 2024 18:06
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 28, 2024
@bedevere-app
Copy link

bedevere-app bot commented Apr 28, 2024

GH-118366 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Apr 28, 2024
hugovk added a commit that referenced this pull request Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants