Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all variables available in package definition functions #805

Open
nerdvegas opened this issue Nov 13, 2019 · 0 comments
Open

Document all variables available in package definition functions #805

nerdvegas opened this issue Nov 13, 2019 · 0 comments

Comments

@nerdvegas
Copy link
Contributor

In a package.py, various different objects (such as env, this) are available depending on whether a package is being built, and where you are in the package definition (ie, in an early bound func, or late bound, or in a commands or commands-like function).

The existing docs do describe what objects are available in what context, but it's hard to track this without the info being provided in one place.

A table should be added showing a matrix of potential cases (eg, in commands, building=true; in early bound func, etc), along with the available objects, and a description of each.

Related - there should also be a table showing which package attributes are available in released packages (as some are stripped according to some rules). Currently this is just a list, but it needs to be updated (eg, I think private_build_requires is actually kept in the released pkg now).

https://github.com/nerdvegas/rez/wiki/Package-Definition-Guide#build-time-package-attributes

@JeanChristopheMorinPerso JeanChristopheMorinPerso changed the title add tables to 'Package Definition' doc page Document all variables available in package definition functions Mar 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant