Skip to content

Commit

Permalink
Updated Configuration and added Tunables documentation
Browse files Browse the repository at this point in the history
- we currently put some tunable information in Configuration, but it was static. The new tunables doc is generated from dafext.md via 'sbt genTunablesDoc'

DAFFODIL-2758
  • Loading branch information
olabusayoT committed Nov 4, 2024
1 parent 5f380ac commit b72f29c
Show file tree
Hide file tree
Showing 2 changed files with 395 additions and 61 deletions.
62 changes: 1 addition & 61 deletions site/configuration.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -58,64 +58,4 @@ Tunable parameters can be modified to change Daffodil schema compilation and dat
</dfdlConfig>
```

Below is a description of the available tunable parameters:

``generatedNamespacePrefixStem``

: If elementFormDefault is qualified, but no prefix is associated with the targetNamespace, a prefix will be created using this value, with numbers appended if necessary to ensure uniqueness. Defaults to "tns".

``inputFileMemoryMapLowThreshold``

: In certain I/O optimized situations (text-only, encodingErrorPolicy='replace', fixed-width encoding) input files larger than this will be mmapped. Input files smaller than this will be simply read using ordinary I/O (because for small files that is just faster). This exists because mmap is more expensive than ordinary I/O for small files. Defaults to 225.

``maxBinaryDecimalVirtualPoint``

: An upper limit on the value of the dfdl:binaryDecimalVirtualPoint property. Defaults to 200.

``maxFieldContentLengthInBytes``

: A maximum limit for various daffodil I/O properties, including the maximim size of a simple element and maximum regular expression characters to match. Defaults to 220.

``maxLengthForVariableLengthDelimiterDisplay``

: When unexpected text is found where a delimiter is expected, this is the maximum number of bytes (characters) to display when the expected delimiter is a variable length delimiter. Defaults to 10.

``maxOccursBounds``

: A maximum limit for the number of repeats of array elements. Defaults to 1024.

``maxSkipLengthInBytes``

: A maximum limit for the number of bytes that can be skipped in a skip region. Defaults to 1024.

``minBinaryDecimalVirtualPoint``

: A lower limit on the value of the dfdl:binaryDecimalVirtualPoint property. Defaults to -200.

``parseUnparsePolicy``

: Whether to compile a schema to support parsing ("parseOnly"), unparsing ("unparseOnly"), both parsing and unparsing ("both"), or to use the daf:parseUnparsePolicy property from the root node ("schema"). Defaults to "both".

``requireBitOrderProperty``

: If true, require that the bitOrder property is specified. If false, use a default value for bitOrder if not defined in a schema. Defaults to false.

``requireEncodingErrorPolicyProperty``

: If true, require that the encodingErrorPolicy property is specified. If false, use a default value if not defined in a schema. Defaults to false.

``unqualifiedPathStepPolicy``

: Specified how unqualified path steps are resolved. Defaults to ``noNamespace``. Value values are:

``noNamespace``

: Unqualified path steps remain unqualified and will only match elements in NoNamespace. A prefix must be provided to match namespaced elements.

``defaultNamespace``

: Unqualified path steps will always use the default namespace. If a default namespace is defined, it is not possible to match a NoNamespace element with this policy. Because of this, this may not work well with elementFormDefault="unqualified".

``preferDefaultNamespace``

: Attempt to use the default namespace to resolve an unqualified path step. If that fails to match an element, then try to resolve using NoNamespace.
See [tunables](/tunables) for a description of the available tunable parameters.
Loading

0 comments on commit b72f29c

Please sign in to comment.