Description

ezio-melotti

opened on Dec 9, 2022

Issue body actions

This is a follow-up of #984:

There are a few broken links that I haven't touched yet:

(developer-workflow/grammar: line 40) broken https://github.com/python/cpython/blob/main/Include/Python-ast.h
(developer-workflow/grammar: line 33) broken https://github.com/python/cpython/blob/main/Include/token.h
(internals/compiler: line 516) broken https://github.com/python/cpython/blob/main/Include/code.h
(internals/compiler: line 488) broken https://github.com/python/cpython/blob/main/Python/peephole.c

• Include/Python-ast.h was removed by @vstinner
  • bpo-43244: Remove ast.h, asdl.h, Python-ast.h headers cpython#24933
• Include/token.h was removed by @vstinner
  • gh-92651: Remove the Include/token.h header file cpython#92652
• Include/code.h was removed by @vstinner
  • bpo-35134: Remove the Include/code.h header file cpython#32385
• Python/peephole.c was removed by @markshannon
  • bpo-41323: Perform 'peephole' optimizations directly on the CFG. cpython#21517

The respective sections in developer-workflow/grammar.rst and internals/compiler.rst might need to be revisited.
@vstinner and @markshannon: can you advise on whether these are quick fixes that we can include in this PR or if they should be handled separately?

I found another file mentioned in the devguide that was deleted:

• Python/wordcode_helpers.h was removed by @brandtbucher
  • bpo-46841: Use *inline* caching for BINARY_OP cpython#31543

Activity

1. ezio-melotti

   added

   bug

   help wanted

   on Dec 9, 2022
2. ezio-melotti

   assigned

   vstinner

   ,

   markshannon

   and

   brandtbucher

   on Dec 9, 2022
3. vstinner commented on Dec 13, 2022

   

   vstinner

   on Dec 13, 2022

   Member

   More actions

   Include/Python-ast.h was removed by @vstinner

   Not removed, read the commit: it was moved to Include/internal/pycore_ast.h.

   Include/token.h was removed by @vstinner

   Same, just renamed to to Include/internal/pycore_token.h.

   I prefer to say "removed" for end users, since end users are not supposed to consume the internal C API.

   Include/code.h was removed by @vstinner

   This file was basically empty: you should use Include/cpython/code.h instead.

   Reacted by Ezio Melotti
4. abdnafees commented on Mar 13, 2023

   

   abdnafees

   on Mar 13, 2023

   Contributor

   More actions

   Does this issue require more changes?
5. CAM-Gerlach commented on Mar 13, 2023

   

   CAM-Gerlach

   on Mar 13, 2023

   Member

   More actions

   I believe so, as most of the existing PRs focused on the existing :files: role rather than file paths using literals. You could consider looking through the various docs that discuss the CPython source tree and updating references to specific files where appropriate. I do note there are tons of missing references in the C-API page, but as that is currently being heavily modified by #1060 withmany of those updated already, I wouldn't touch it until after that is merged (and I plan to submit an immediate followup anyway which may address more, so I'd wait on that until given the go-ahead).
6. abdnafees commented on Mar 13, 2023

   

   abdnafees

   on Mar 13, 2023

   Contributor

   More actions

   Got it.

   So for example here

   Add the PyTestCapi_Init* function to Modules/_testcapi/parts.h
   Call the PyTestCapi_Init* from PyInit__testcapi in Modules/_testcapimodule.c.

   Am I looking at the right place?
7. CAM-Gerlach commented on Mar 14, 2023

   

   CAM-Gerlach

   on Mar 14, 2023

   Member

   More actions

   Those are examples of things you would normally want to submit a PR changing, yes, but also examples of things on the C-API page that I mentioned is currently being modified by #1060 and will be further modified by a followup, so you shouldn't touch those until that's all done. If you find similar such references in other documents, those would likely be fair game to change as part of one or more PRs.
8. abdnafees commented on Mar 14, 2023

   

   abdnafees

   on Mar 14, 2023

   Contributor

   More actions

   Alright, got it. Thank you.

   Reacted by C.A.M. Gerlach
9. willingc

   added

   type-bugEditing of existing content neededEditing of existing content needed

   on Oct 11, 2023
10. StanFromIreland

    removed

    bug

    on Mar 3, 2026

Issue actions