Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls#107062

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
erlend-aasland merged 9 commits intopython:mainfromerlend-aasland:docs/fix-targets
Jul 23, 2023

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aaslanderlend-aasland commentedJul 22, 2023
edited
Loading

Disable links for C functions [mcr]alloc and free
@serhiy-storchaka
Copy link
Member

malloc,realloc andfree are referred in many different files. Maybe add them innitpick_ignore? Andcalloc for complete.

@erlend-aasland
Copy link
ContributorAuthor

malloc,realloc andfree are referred in many different files. Maybe add them innitpick_ignore? Andcalloc for complete.

Yes, I noticed. I'll add them, and I'll remove the_weakref since it does not belong to this PR really.

@erlend-aaslanderlend-aasland changed the titleDocs: Disable links for _weakref and C stdlib functionsDocs: Disable links for some C stdlib functionsJul 22, 2023
@serhiy-storchaka
Copy link
Member

The most referred functions:

      3 :c:func:`!addstr`      3 :c:func:`calloc`      3 :c:func:`exec`      3 :c:func:`function__entry`      3 :c:func:`printf`      3 :c:func:`sigaction`      3 :c:func:`signal`      3 :c:func:`sprintf`      3 :c:func:`strerror`      4 :c:func:`devpoll`      4 :c:func:`lockf`      4 :c:func:`main`      4 :c:func:`snprintf`      4 :c:func:`stat`      4 :c:func:`system`      4 :c:func:`vsnprintf`      5 :c:func:`dlopen`      5 :c:func:`fcntl`      5 :c:func:`flock`      5 :c:func:`!getopt`      5 :c:func:`!scanf`      6 :c:func:`realloc`      8 :c:func:`select`      9 :c:func:`poll`     11 :c:func:`gmtime`     11 :c:func:`localtime`     18 :c:func:`fork`     21 :c:func:`free`     34 :c:func:`malloc`

Some of them, likegetopt are only referred in one file.

erlend-aasland reacted with hooray emoji

@erlend-aaslanderlend-aasland changed the titleDocs: Disable links for some C stdlib functionsDocs: Disable links for C standard library functions, OS utility functions and system callsJul 22, 2023
@erlend-aaslanderlend-aasland marked this pull request as ready for reviewJuly 22, 2023 19:50
@serhiy-storchakaserhiy-storchaka changed the titleDocs: Disable links for C standard library functions, OS utility functions and system callsgh-106948: Docs: Disable links for C standard library functions, OS utility functions and system callsJul 23, 2023
@serhiy-storchakaserhiy-storchaka linked an issueJul 23, 2023 that may beclosed by this pull request
@serhiy-storchaka
Copy link
Member

  1. I am not sure that all functions referred at least 3 times should be added innitpick_ignore. Many of them are only referred in one file (excluding NEWS entries). Memory management functionsmalloc,realloc andfree are obvious candidates for inclusion.calloc can also be included besides it is only referred 3 times.gmtime andlocaltime are referred several times in two related modules, they also can be included.fork is referred in multiple files.poll is only referred in select.rst, but multiple times, it is questionable. Etc, etc. On other side,addstr is only mentioned in curses.rst, and in all three cases already with!. To me, it is an obvious candidate for not inclusion.function__entry is a strange thing, is it even a standard name?

  2. I did not differentiate between C, Posix and Windows types, Posix and Windows environment variables. It is tiresome to find where exactly the name is defined (and some are defined on multiple platforms), and it does not really matter. I only grouped by the role.

It is my thoughts. If you disagree, go ahead, but may be some of them can be useful to you.

erlend-aasland reacted with thumbs up emoji

@erlend-aasland
Copy link
ContributorAuthor

erlend-aasland commentedJul 23, 2023
edited
Loading

Thanks for your input. I think it makes sense to remove functions which are only mentioned a few times, and instead use! to mark them up. I'll return to this later today.

@erlend-aaslanderlend-aasland requested a review froma team as acode ownerJuly 23, 2023 20:10
@erlend-aasland
Copy link
ContributorAuthor

Thanks for the review and insight, Serhiy. Highly appreciated!

@erlend-aaslanderlend-aasland merged commitb447e19 intopython:mainJul 23, 2023
@miss-islington
Copy link
Contributor

Thanks@erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@erlend-aaslanderlend-aasland deleted the docs/fix-targets branchJuly 23, 2023 20:57
@miss-islington
Copy link
Contributor

Sorry,@erlend-aasland, I could not cleanly backport this to3.11 due to a conflict.
Please backport usingcherry_picker on command line.
cherry_picker b447e19e720e6781025432a40eb72b1cc93ac944 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestJul 23, 2023
…, OS utility functions and system calls (pythonGH-107062)(cherry picked from commitb447e19)Co-authored-by: Erlend E. Aasland <erlend@python.org>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-bot
Copy link

GH-107154 is a backport of this pull request to the3.12 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.12only security fixes labelJul 23, 2023
erlend-aasland added a commit that referenced this pull requestJul 23, 2023
…s, OS utility functions and system calls (GH-107062) (#107154)(cherry picked from commitb447e19)Co-authored-by: Erlend E. Aasland <erlend@python.org>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-bot
Copy link

GH-107157 is a backport of this pull request to the3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11only security fixes labelJul 23, 2023
erlend-aasland added a commit that referenced this pull requestJul 23, 2023
…s, OS utility functions and system calls (#107062) (#107157)(cherry picked from commitb447e19)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
mementum pushed a commit to mementum/cpython that referenced this pull requestJul 23, 2023
…, OS utility functions and system calls (python#107062)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
carljm added a commit to carljm/cpython that referenced this pull requestJul 24, 2023
* main: (73 commits)  Thoroughly refactor the cases generator (python#107151)  Docs: Add missing markup to Argument Clinic docs (python#106876)pythongh-107162: Document errcode.h usage in its comment (python#107177)pythongh-106320: Remove private _PyDict C API (python#107145)  Fix PyVectorcall_Function doc versionadded (python#107140)  Docs: Remove duplicate word in Argument Clinic howto heading (python#107169)pythongh-107017: Change Chapter Strings to Texts in the Introduction chapter. (python#107104)pythongh-106320: Remove private _PyObject C API (python#107159)  Docs: fix typo in os.pwrite docstring (python#107087)pythongh-105291: Add link to migration guide for distutils (python#107130)pythongh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (python#107062)pythongh-106320: Remove _PyBytes_Join() C API (python#107144)pythongh-106320: Remove private _PyObject C API (python#107147)pythongh-106320: Remove _PyTuple_MaybeUntrack() C API (python#107143)pythongh-106320: Remove _PyIsSelectable_fd() C API (python#107142)  Remove superflous whitespaces in `layout.html`. (pythonGH-107067)pythongh-107122: Update what's news for dbm.*dbm.clear() method (pythongh-107135)pythongh-107122: Add clear method to dbm.ndbm module (pythongh-107126)pythongh-62519: Make pgettext search plurals when translation is not found (python#107118)pythongh-107122: Add clear method to dbm.gdbm.module (pythongh-107127)  ...
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

Assignees

@erlend-aaslanderlend-aasland

Labels
docsDocumentation in the Doc dirskip issueskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@erlend-aasland@serhiy-storchaka@miss-islington@bedevere-bot

[8]ページ先頭

©2009-2025 Movatter.jp