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

gh-102304: Enhance Simple ABI doc by vstinner · Pull Request #105351 · python/cpython · GitHub

Repository navigation

gh-102304: Enhance Simple ABI doc - #105351

Merged
encukou merged 2 commits into
python:mainfrom
vstinner:limited_capi_enhance
Jun 6, 2023
Merged

encukou merged 2 commits into
python:mainfrom
vstinner:limited_capi_enhance

Conversation

vstinner commented Jun 6, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Comment thread Makefile.pre.in Outdated
# - Lib/test/test_stable_abi_ctypes.py
# - Modules/_testcapi_feature_macros.inc
# - PC/python3dll.c
# https://devguide.python.org/developer-workflow/c-api/#adding-a-new-definition-to-the-limited-api

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

Could you remove the list of files, which will become outdated in time?

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

Or: why is this needed? I can keep it up to date if there's a need for it.

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 like to know which files are generated by make by reading the Makefile. I would prefer to not have to open a web browser. Moreover, the linked URL doesn't list which files are modified.

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

The commnand to list them is ./python Tools/build/stable_abi.py --list . (and with #105355 the dot will be unnecessary.)
Is that enough? If not I can add a check to make sure Makefile is up to date.

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

You seem to worry more than me that such comment can be outdated. I can survive without this comment, so I just removed it. I would like to backport my C API doc change to 3.12 to unblock PR #105352 fix.

So it's no longer needed to maintain it.
encukou merged commit 0202aa0 into python:main Jun 6, 2023

encukou commented Jun 6, 2023

Copy link
Copy Markdown
Member

Thanks!

vstinner deleted the limited_capi_enhance branch June 6, 2023 12:38
vstinner added a commit to vstinner/cpython that referenced this pull request Jun 6, 2023

vstinner commented Jun 6, 2023

Copy link
Copy Markdown
Member Author

Thanks for the review. I wrote a new PR for 3.12 which combines the 2 doc changes: PR #105371.

vstinner added a commit that referenced this pull request Jun 6, 2023
…5345) (#105371)

* gh-102304: doc: Add links to Stable ABI and Limited C API (#105345)

* Add "limited-c-api" and "stable-api" references.
* Rename "stable-abi-list" reference to "limited-api-list".
* Makefile: Document files regenerated by "make regen-limited-abi"
* Remove first empty line in generated files:

  - Lib/test/test_stable_abi_ctypes.py
  - PC/python3dll.c

(cherry picked from commit bae415a)

* gh-102304: Fix up Simple ABI doc (GH-105351)

(cherry picked from commit 0202aa0)
AA-Turner pushed a commit to AA-Turner/cpython that referenced this pull request Sep 26, 2023
python#105345) (python#105371)

* pythongh-102304: doc: Add links to Stable ABI and Limited C API (python#105345)

* Add "limited-c-api" and "stable-api" references.
* Rename "stable-abi-list" reference to "limited-api-list".
* Makefile: Document files regenerated by "make regen-limited-abi"
* Remove first empty line in generated files:

  - Lib/test/test_stable_abi_ctypes.py
  - PC/python3dll.c

(cherry picked from commit bae415a)

* pythongh-102304: Fix up Simple ABI doc (pythonGH-105351)

(cherry picked from commit 0202aa0)
(cherry picked from commit 82ab13c)
AA-Turner pushed a commit to AA-Turner/cpython that referenced this pull request Sep 26, 2023
python#105345) (python#105371)

* pythongh-102304: doc: Add links to Stable ABI and Limited C API (python#105345)

* Add "limited-c-api" and "stable-api" references.
* Rename "stable-abi-list" reference to "limited-api-list".
* Makefile: Document files regenerated by "make regen-limited-abi"
* Remove first empty line in generated files:

  - Lib/test/test_stable_abi_ctypes.py
  - PC/python3dll.c

(cherry picked from commit bae415a)

* pythongh-102304: Fix up Simple ABI doc (pythonGH-105351)

(cherry picked from commit 0202aa0)
(cherry picked from commit 82ab13c)
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
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.

3 participants


Back | FazBrowse Home | New Git URL