Step execution environment documentation is incomplete and out of date

[lengau]

What needs to get done

The Step execution environment documentation is incomplete, missing at least the following:

• CRAFT_ARCH_BUILD_ON
• CRAFT_ARCH_BUILD_FOR
• CRAFT_ARCH_TRIPLET_BUILD_ON
• CRAFT_ARCH_TRIPLET_BUILD_FOR
• CRAFT_STEP_NAME

The first four of those are especially problematic since they replace deprecated keys, and the documentation doesn't note that CRAFT_ARCH_TRIPLET and CRAFT_TARGET_ARCH are deprecated.

It also doesn't include several changes to existing environment variables that we make, including:

• Prepending a large number of directories to $PATH (roughly equivalent to exporting PATH=$CRAFT_PART_INSTALL/usr/sbin:$CRAFT_PART_INSTALL/usr/bin:$CRAFT_PART_INSTALL/sbin:$CRAFT_PART_INSTALL/bin:$CRAFT_STAGE/usr/sbin:$CRAFT_STAGE/usr/bin:$CRAFT_STAGE/sbin:$CRAFT_STAGE/bin:$PATH)
• Similar changes to CPPFLAGS, CFLAGS, CXXFLAGS
• Related changes to LDFLAGS
• Similar changes to PKG_CONFIG_PATH

Why it needs to get done

The former group can be frustrating for users who don't know what to do about our deprecation notice, and the latter can cause confusion to users if, for example, an unexpected executable gets run.

[syncronize-issues-to-jira]

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3846.

This message was autogenerated