Skip to content

Commit 453e9ee

Browse files
lucascolleyhugovk
andauthored
Apply suggestions from code review
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 4d0983e commit 453e9ee

4 files changed

Lines changed: 15 additions & 15 deletions

File tree

Tools/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ patchcheck Tools for checking and applying patches to the Python source cod
4343

4444
peg_generator PEG-based parser generator (pegen) used for new parser.
4545

46-
pixi-packages Pixi package definitions for downstream from-source builds
46+
pixi-packages Pixi package definitions for downstream from-source builds.
4747

4848
scripts A number of useful single-file programs, e.g. run_tests.py
4949
which runs the Python test suite.

Tools/pixi-packages/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## CPython Pixi Packages
1+
# CPython Pixi packages
22

33
This directory contains definitions for [Pixi packages](https://pixi.sh/latest/reference/pixi_manifest/#the-package-section)
44
which can be built from the CPython source code.
55

6-
Downstream developers can make use of these packages by adding them as git dependencies in a
6+
Downstream developers can make use of these packages by adding them as Git dependencies in a
77
[Pixi workspace](https://pixi.sh/latest/first_workspace/), like:
88

99
```toml
@@ -13,7 +13,7 @@ python = { git = "https://github.com/python/cpython", subdirectory = "Tools/pixi
1313

1414
This is particularly useful when developers need to build CPython from source
1515
(for example, for an ASan-instrumented build), as it does not require any manual
16-
cloning or building steps. Instead, Pixi will automatically handle both the building
16+
clone or build steps. Instead, Pixi will automatically handle both the build
1717
and installation of the package.
1818

1919
Each package definition is contained in a subdirectory, but they share the build script
@@ -22,15 +22,15 @@ Each package definition is contained in a subdirectory, but they share the build
2222
- `default`
2323
- `asan`: ASan-instrumented build with `PYTHON_ASAN=1`
2424

25-
### Maintenance
25+
## Maintenance
2626

27-
- the `version` fields in each `recipe.yaml` should be kept up to date with the Python version
28-
- dependency requirements should be kept up to date in each `recipe.yaml`
29-
- `build.sh` should be updated for any breaking changes in the `configure` and `make` workflow
27+
- Keep the `version` fields in each `recipe.yaml` up to date with the Python version
28+
- Keep the dependency requirements up to date in each `recipe.yaml`
29+
- Update `build.sh` for any breaking changes in the `configure` and `make` workflow
3030

31-
### Opportunities for future improvement
31+
## Opportunities for future improvement
3232

33-
- more package variants (e.g. TSan, UBSan)
34-
- support for Windows
35-
- using a single `pixi.toml` and `recipe.yaml` for all package variants is blocked on https://github.com/prefix-dev/pixi/issues/4599
36-
- a workaround can be removed from the build script once https://github.com/prefix-dev/rattler-build/issues/2012 is resolved
33+
- More package variants (such as TSan, UBSan)
34+
- Support for Windows
35+
- Using a single `pixi.toml` and `recipe.yaml` for all package variants is blocked on https://github.com/prefix-dev/pixi/issues/4599
36+
- A workaround can be removed from the build script once https://github.com/prefix-dev/rattler-build/issues/2012 is resolved

Tools/pixi-packages/asan/recipe.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
context:
2-
# XXX: keep up to date
2+
# Keep up to date
33
version: "3.15"
44

55
package:

Tools/pixi-packages/default/recipe.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
context:
2-
# XXX: keep up to date
2+
# Keep up to date
33
version: "3.15"
44

55
package:

0 commit comments

Comments
 (0)