Bug 280061

Summary: Porters Handbook: missing important aspects: PEP517 (python)
Product: Documentation Reporter: O. Hartmann <ohartmann>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: New ---    
Severity: Affects Many People    
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   

Description O. Hartmann 2024-06-30 08:34:00 UTC
The porters handbook is missing an important aspect when using python software utilising pyproject.toml.

Wiki (https://wiki.freebsd.org/Python/PortsPolicy) states:

[...]
USE_PYTHON Features
...
pep517

blabla ... (have a pyproject.toml specifying a build backend that builds an installable wheel) ... blabla
[...]

This feature is only available on Wiki page, but is missing in the official documentation project's pages, found on https://docs.freebsd.org/en/books/porters-handbook/book/

Experience of the past decades left me back considering Wiki pages as outdated in some aspects, I guess I'm not the only one, so I may be wrong, also wronging the Porters Handbook being the main source of documentation.

I'd like to see this mentioned aspect of use_python=pep517 and it's related pyproject.toml file mentioned in the official documentation.

Several github.com based python ports/project use pyproject.toml instead of setup.py. I couldn't find anything about a implicit standard taken when setup.py is missing in the official handbook, so it took me a couple of time finding out about this, unnecessary to mention that it's a steep way to climb for an not-so-skilled-developer.

If interested, some Espressif projects in the waters of ESP32 development utilise "PEP517 method" of the installation process .

Thank you very much