Build Internal Operations

---

Documentation Access

__bashDocumentationCached

Display cached usage for a function

Usage

__bashDocumentationCached handler [ home ] [ functionName ] [ returnCode ] [ message ... ]

Display cached usage for a function

Location: bin/build/tools/usage.sh

Arguments

• handler - Function. Required.
• home - Directory. BUILD_HOME
• functionName - String. Function to display usage for
• returnCode - UnsignedInteger. Optional. Exit code to display. Defaults to 0 - no error.
• message ... - String. Optional. Display this message which describes why exitCode occurred.

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Environment

• BUILD_HOME Build Home Directory – Directory. BUILD_HOME is . when this code is installed - at BUILD_COLORS Build Colors Flag – Boolean. If true then colors are shown, blank means guess the BUILD_DOCUMENTATION_PATH Build Documentation Path List – DirectoryList. Search path for documentation settings file.

Requires

• decorateThemed - Applies the current theme to text rendered using `decorateThemelessMode` (source)
• catchEnvironment - Run `command`, upon failure run `handler` with an environment error (source)
• decorate - decorate text using colors and styles (source)

__functionSettings

Load cached function comment values

Usage

__functionSettings [ home ] [ functionName ] [ generatePath ]

Load cached function comment values

Location: bin/build/tools/usage.sh

Arguments

• home - Directory. BUILD_HOME
• functionName - String. Function to fetch settings for
• generatePath - Boolean. Optional. Pass in true to just generate the file path and not require the file to exist.

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Environment

• BUILD_DOCUMENTATION_PATH Build Documentation Path List – DirectoryList. Search path for documentation settings file.

__usageMessage

Output the message for usage consistently

Usage

__usageMessage [ returnCode ] [ message ... ]

Output the message for usage consistently

Location: bin/build/tools/usage.sh

Arguments

• returnCode - UnsignedInteger. Optional. Exit code to possibly display with message.
• message ... - String. Optional. Display this message which describes why exitCode occurred.

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Requires

• decorate - decorate text using colors and styles (source)
• returnCodeString - Output the exit code as a string (source)

Platform Support

__dateFromTimestamp

Platform dateFromTimestamp

Usage

__dateFromTimestamp value format [ isUTC ]

Platform-specific implementation of dateFromTimestamp.

Location: bin/build/tools/platform/Darwin.sh

Arguments

• value - Integer. Required.
• format - String. Required.
• isUTC - Boolean. Optional. Defaults to true.

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Requires

• date

Get a copy of the Apache License

{buildFetchLicense}

Building markdown documentation

{buildDocumentationBuild}

{buildDocumentationMkdocs}

{buildDocumentationEnvironment}

{buildDocumentationTemplates}

Generating cache files

{buildFunctionsCompile}

{documentationFileCompileParallel}

{buildFunctionsRemoveDeprecated}

{buildToolsCompile}

Deployment

{buildStepInitialize}

Development

{repairProfile}

{buildPreRelease}

{buildPreReleaseLintFiles}

{buildAddTool}

{buildPR}

SEE Hunting

{buildFunctionsListSeeUnfinished}

{buildFunctionsSeeAgain}

{buildFunctionsSeeLoop}

Testing Wrappers

{buildTestPlatforms}

{buildTestSuite}

{buildTestSuiteIndex}

{buildQuickTest}

{buildStagingTest}

{buildProductionTest}

{buildBuildTiming}

{buildContainer}

---

🛠️ Tools · ⬅ Top