documentation for all public and private environment variables recognized by apptainer about apptainer HOT 4 OPEN

FYI, there are lists in the docs at present. See e.g.....

Env vars accepted by the CLI... https://github.com/sylabs/singularity-userdocs/blob/master/appendix.rst

Env vars set in the container environment... https://github.com/sylabs/singularity-userdocs/blob/master/environment_and_metadata.rst#environment-from-the-singularity-runtime

NB - I'm following the stuff on environment due to a vested interest in understanding the decisions on the SINGULARITY / APPTAINER prefix compatibility stuff etc.

from apptainer.

Isn't it better for them to be in the userdocs or admindocs?

from apptainer.

I am a big fan of a "single source of truth" with minimal likelyhood of getting out of sync. That being said, the source code repo is the ultimate source of truth, and having the developer maintain basic essential documentation is needed to keep them in sync. The user/admin docs can more easily reference a single MD file in the source repo than to generally say "see the follow source file directories and parse them yourself".

from apptainer.

also, while in the same repo, it is eminently possible to have an automated test compare the source code with the documentation to flag any inconsistencies.

from apptainer.