FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix Sphinx warnings in `library/faulthandler.rst` by hugovk · Pull Request #118353 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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

Merged
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-faulthandler
Apr 28, 2024
ConversationCommits (1)ChecksFiles changed
Merged

gh-101100: Fix Sphinx warnings in library/faulthandler.rst#118353
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-faulthandler

Conversation

hugovk commented Apr 27, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

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/

bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting core review labels Apr 27, 2024
bedevere-app Bot mentioned this pull request Apr 27, 2024
Closed

AlexWaygood commented Apr 27, 2024

Copy link
Copy Markdown
Member

PR title is interesting 👀

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 commented Apr 27, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

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 changed the title gh-101100: Fix Sphinx warnings in library/faulthandler.rst gh-101100: Fix Sphinx warnings in library/faulthandler.rst Apr 27, 2024
AlexWaygood approved these changes Apr 28, 2024
View reviewed changes
Comment thread Doc/library/faulthandler.rst
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

AlexWaygood Apr 28, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

hugovk Apr 28, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

cpython/Modules/faulthandler.c

Line 11 in e0ab642

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

cpython/Modules/faulthandler.c

Lines 591 to 592 in e0ab642

if (thread.exit)
_exit(1);

AlexWaygood Apr 28, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 merged commit 33c6cf3 into python:main Apr 28, 2024
hugovk deleted the docs-fix-sphinx-warnings-faulthandler branch April 28, 2024 18:06

miss-islington-app Bot commented Apr 28, 2024

Copy link
Copy Markdown

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
pythongh-101100: Fix Sphinx warnings in library/faulthandler.rst (p…
cb9a6bd 
…ythonGH-118353)

(cherry picked from commit 33c6cf3)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

bedevere-app Bot commented Apr 28, 2024

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Apr 28, 2024
hugovk added a commit that referenced this pull request Apr 28, 2024
[3.12] gh-101100: Fix Sphinx warnings in library/faulthandler.rst (G…
817190c 
…H-118353) (#118366)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AlexWaygood AlexWaygood approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL