GH-116218 Docs: Add availability information for the 'resource' module #116256

Privat33r-dev · 2024-03-03T01:04:27Z

Issue: Availbility of resource constants not properly documented #116218

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

ronaldoussoren

I've added some comments about the availability of a number of constants that have much wider availability than claimed by this PR.

I have not checked beyond macOS and FreeBSD, further resource is needed to update the availability statement. The constants I marked as being available on macOS and FreeBSD as well may well be available on all relevant unix-y platforms.

The symbols I marked as being part of the unix spec should IMHO not have availability information.

ronaldoussoren · 2024-03-08T08:40:24Z

Doc/library/resource.rst

@@ -123,6 +123,8 @@ platform.
   This may result in the creation of a partial core file if a larger core would be
   required to contain the entire process image.

+   .. availability:: Linux >= 1.3.0


This constant is part of the unix standard and should be available on all platforms (given that this module is documented as available on unix platforms).

ronaldoussoren · 2024-03-08T08:41:03Z

Doc/library/resource.rst

@@ -131,37 +133,51 @@ platform.
   the :mod:`signal` module documentation for information about how to catch this
   signal and do something useful, e.g. flush open files to disk.)

+   .. availability:: Linux >= 1.3.0


ronaldoussoren · 2024-03-08T08:41:35Z

Doc/library/resource.rst


 .. data:: RLIMIT_FSIZE

   The maximum size of a file which the process may create.

+   .. availability:: Linux >= 1.3.0


ronaldoussoren · 2024-03-08T08:46:00Z

Doc/library/resource.rst


 .. data:: RLIMIT_DATA

   The maximum size (in bytes) of the process's heap.

+   .. availability:: Linux >= 1.3.0


ronaldoussoren · 2024-03-08T08:46:09Z

Doc/library/resource.rst


 .. data:: RLIMIT_STACK

   The maximum size (in bytes) of the call stack for the current process.  This only
   affects the stack of the main thread in a multi-threaded process.

+   .. availability:: Linux >= 1.3.0


ronaldoussoren · 2024-03-08T08:50:06Z

Doc/library/resource.rst


 .. data:: RLIMIT_RSS

   The maximum resident set size that should be made available to the process.

+   .. availability:: Linux >= 1.3.0


Also available on (at least) macOS and FreeBSD, not mentioned in the unix spec.

ronaldoussoren · 2024-03-08T08:50:27Z

Doc/library/resource.rst


 .. data:: RLIMIT_NPROC

   The maximum number of processes the current process may create.

+   .. availability:: Linux >= 1.3.0


Also available on (at least) macOS and FreeBSD, not mentioned in the unix spec.

ronaldoussoren · 2024-03-08T08:50:48Z

Doc/library/resource.rst


 .. data:: RLIMIT_NOFILE

   The maximum number of open file descriptors for the current process.

+   .. availability:: Linux >= 1.3.0


Part of the unix spec, see above

ronaldoussoren · 2024-03-08T08:52:00Z

Doc/library/resource.rst


 .. data:: RLIMIT_AS

   The maximum area (in bytes) of address space which may be taken by the process.

+   .. availability:: Linux >= 1.3.0


Part of the unix spec, see above.

bedevere-app · 2024-03-08T08:55:42Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Privat33r-dev · 2024-03-08T09:19:29Z

I have made the requested changes; please review again

P.S. Thanks for the review.

ronaldoussoren

LGTM

miss-islington-app · 2024-03-09T09:00:41Z

Thanks @Privat33r-dev for the PR, and @ronaldoussoren for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

… module (pythonGH-116256) Add availability data to 'resource' module Docs (cherry picked from commit 03f86b1) Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>

bedevere-app · 2024-03-09T09:01:03Z

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

… module (pythonGH-116256) Add availability data to 'resource' module Docs (cherry picked from commit 03f86b1) Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>

bedevere-app · 2024-03-09T09:01:09Z

GH-116534 is a backport of this pull request to the 3.11 branch.

…' module (GH-116256) (#116533) GH-116218 Docs: Add availability information for the 'resource' module (GH-116256) Add availability data to 'resource' module Docs (cherry picked from commit 03f86b1) Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>

…' module (GH-116256) (#116534) GH-116218 Docs: Add availability information for the 'resource' module (GH-116256) Add availability data to 'resource' module Docs (cherry picked from commit 03f86b1) Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>

… module (python#116256) Add availability data to 'resource' module Docs

Add availability data to 'resource' module Docs

59d9ce5

bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Mar 3, 2024

bedevere-app bot mentioned this pull request Mar 3, 2024

Availbility of resource constants not properly documented #116218

Closed

Privat33r-dev changed the title ~~GH-116218 Docs; Add availability information for the 'resource' module~~ GH-116218 Docs: Add availability information for the 'resource' module Mar 3, 2024

ronaldoussoren requested changes Mar 8, 2024

View reviewed changes

bedevere-app bot added awaiting changes and removed awaiting review labels Mar 8, 2024

Remove availability labels for unix-standard symbols

48b87f0

Privat33r-dev requested a review from ronaldoussoren March 8, 2024 09:19

ronaldoussoren approved these changes Mar 9, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting changes labels Mar 9, 2024

ronaldoussoren added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Mar 9, 2024

ronaldoussoren merged commit 03f86b1 into python:main Mar 9, 2024

bedevere-app bot removed the awaiting merge label Mar 9, 2024

bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 9, 2024

bedevere-app bot removed the needs backport to 3.11 only security fixes label Mar 9, 2024

Privat33r-dev deleted the docs-improve-116218 branch March 9, 2024 22:42

adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024

pythonGH-116218 Docs: Add availability information for the 'resource'…

06ba4c4

… module (python#116256) Add availability data to 'resource' module Docs

diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024

pythonGH-116218 Docs: Add availability information for the 'resource'…

e3aacb9

… module (python#116256) Add availability data to 'resource' module Docs

Uh oh!

GH-116218 Docs: Add availability information for the 'resource' module #116256

GH-116218 Docs: Add availability information for the 'resource' module #116256

Uh oh!

Conversation

Privat33r-dev commented Mar 3, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ronaldoussoren left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bedevere-app bot commented Mar 8, 2024

Uh oh!

Privat33r-dev commented Mar 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ronaldoussoren left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington-app bot commented Mar 9, 2024

Uh oh!

bedevere-app bot commented Mar 9, 2024

Uh oh!

bedevere-app bot commented Mar 9, 2024

Uh oh!

Uh oh!

Privat33r-dev commented Mar 3, 2024 •

edited by github-actions bot

Loading

Privat33r-dev commented Mar 8, 2024 •

edited

Loading