Skip to content

Commit 6d7ad57

Browse files
authored
Update outdated info in Tools/cases_generator/README.md (#114844)
1 parent 2dea1cf commit 6d7ad57

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

Tools/cases_generator/README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,30 @@ Documentation for the instruction definitions in `Python/bytecodes.c`
55

66
What's currently here:
77

8+
- `analyzer.py`: code for converting `AST` generated by `Parser`
9+
to more high-level structure for easier interaction
810
- `lexer.py`: lexer for C, originally written by Mark Shannon
911
- `plexer.py`: OO interface on top of lexer.py; main class: `PLexer`
10-
- `parsing.py`: Parser for instruction definition DSL; main class `Parser`
11-
- `generate_cases.py`: driver script to read `Python/bytecodes.c` and
12+
- `parsing.py`: Parser for instruction definition DSL; main class: `Parser`
13+
- `parser.py` helper for interactions with `parsing.py`
14+
- `tierN_generator.py`: a couple of driver scripts to read `Python/bytecodes.c` and
1215
write `Python/generated_cases.c.h` (and several other files)
13-
- `analysis.py`: `Analyzer` class used to read the input files
14-
- `flags.py`: abstractions related to metadata flags for instructions
15-
- `formatting.py`: `Formatter` class used to write the output files
16-
- `instructions.py`: classes to analyze and write instructions
17-
- `stacking.py`: code to handle generalized stack effects
16+
- `stack.py`: code to handle generalized stack effects
17+
- `cwriter.py`: code which understands tokens and how to format C code;
18+
main class: `CWriter`
19+
- `generators_common.py`: helpers for generators
20+
- `opcode_id_generator.py`: generate a list of opcodes and write them to
21+
`Include/opcode_ids.h`
22+
- `opcode_metadata_generator.py`: reads the instruction definitions and
23+
write the metadata to `Include/internal/pycore_opcode_metadata.h`
24+
- `py_metadata_generator.py`: reads the instruction definitions and
25+
write the metadata to `Lib/_opcode_metadata.py`
26+
- `target_generator.py`: generate targets for computed goto dispatch and
27+
write them to `Python/opcode_targets.h`
28+
- `uop_id_generator.py`: generate a list of uop IDs and write them to
29+
`Include/internal/pycore_uop_ids.h`
30+
- `uop_metadata_generator.py`: reads the instruction definitions and
31+
write the metadata to `Include/internal/pycore_uop_metadata.h`
1832

1933
Note that there is some dummy C code at the top and bottom of
2034
`Python/bytecodes.c`

0 commit comments

Comments
 (0)