]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Update outdated info in ``Tools/cases_generator/README.md`` (#114844)
authorKirill Podoprigora <kirill.bast9@mail.ru>
Thu, 1 Feb 2024 16:56:24 +0000 (19:56 +0300)
committerGitHub <noreply@github.com>
Thu, 1 Feb 2024 16:56:24 +0000 (08:56 -0800)
Tools/cases_generator/README.md

index ed802e44f31ad5f32c99b7ceeaae1a20e2aa14e4..7fec8a882336cdf7383d70dc53293addcd315190 100644 (file)
@@ -5,16 +5,30 @@ Documentation for the instruction definitions in `Python/bytecodes.c`
 
 What's currently here:
 
+- `analyzer.py`: code for converting `AST` generated by `Parser`
+  to more high-level structure for easier interaction
 - `lexer.py`: lexer for C, originally written by Mark Shannon
 - `plexer.py`: OO interface on top of lexer.py; main class: `PLexer`
-- `parsing.py`: Parser for instruction definition DSL; main class `Parser`
-- `generate_cases.py`: driver script to read `Python/bytecodes.c` and
+- `parsing.py`: Parser for instruction definition DSL; main class: `Parser`
+- `parser.py` helper for interactions with `parsing.py`
+- `tierN_generator.py`: a couple of driver scripts to read `Python/bytecodes.c` and
   write `Python/generated_cases.c.h` (and several other files)
-- `analysis.py`: `Analyzer` class used to read the input files
-- `flags.py`: abstractions related to metadata flags for instructions
-- `formatting.py`: `Formatter` class used to write the output files
-- `instructions.py`: classes to analyze and write instructions
-- `stacking.py`: code to handle generalized stack effects
+- `stack.py`: code to handle generalized stack effects
+- `cwriter.py`: code which understands tokens and how to format C code;
+  main class: `CWriter`
+- `generators_common.py`: helpers for generators
+- `opcode_id_generator.py`: generate a list of opcodes and write them to
+  `Include/opcode_ids.h`
+- `opcode_metadata_generator.py`: reads the instruction definitions and
+  write the metadata to `Include/internal/pycore_opcode_metadata.h`
+- `py_metadata_generator.py`: reads the instruction definitions and
+  write the metadata to `Lib/_opcode_metadata.py`
+- `target_generator.py`: generate targets for computed goto dispatch and
+  write them to `Python/opcode_targets.h`
+- `uop_id_generator.py`: generate a list of uop IDs and write them to
+  `Include/internal/pycore_uop_ids.h`
+- `uop_metadata_generator.py`: reads the instruction definitions and
+  write the metadata to `Include/internal/pycore_uop_metadata.h`
 
 Note that there is some dummy C code at the top and bottom of
 `Python/bytecodes.c`