Legend

NVIDIA Build-FS CONFIG is a valid JSON file and hence we can consider the file as a JSON Object. The terminologies used here are from JSON (https://en.wikipedia.org/wiki/JSON#Data_types_and_syntax).

Field

List of all the keys supported by NVIDIA Build-FS CONFIG.

Type

Type of Value the keys should have.

Acceptable Values

  • Additional information on what the Value should be.
  • Key content -> If Value is of type object, then its keys should be a String and must adhere to the conditions specified here.
  • Value type -> If Value is of type object, then the object's value must be of the type specified here.
  • Value contents -> If Value is of type object, then the object's value must adhere to the conditions specified here.
  • Items type -> If Value is of type array, then the array's values must be of the type specified here.
  • Items contents -> If Value is of type array, then the array's values must adhere to the conditions specified here.
  • enum [a, b, c] -> Implies Value must be one of a, b or c.
  • Valid UNIX filename -> Valid String, which do not contain characters specified here: https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words

Valid UNIX filepath -> Valid String, which is a combination of 'Valid UNIX filename'(s) joined via /, which should point to an existing file.

REQ

This row can have the following values:

  1. Yes -> The Field Must be present in the CONFIG with a non-empty value.
  2. No -> If the Field is not present in the CONFIG, the default shall be used, else specified value is used.

Default

Specifies the Default value for 'Not Required' fields if they are absent from the CONFIG file.

The row can have the following standard values apart from actual default values.

  • N/A -> Cannot have a default value. (Required)
  • empty -> Doesn't have a default value. (Getter shall return None)

Syntax

Specifies the Syntax of usage of the field in the CONFIG file. Useful for a Visual understanding of Type and Acceptable Values.

Instructions

Additional information on how the fields are used by Build-FS and what behavior would it cause.

Examples

Example usage of the field in the CONFIG file.