[
https://issues.apache.org/jira/browse/DAFFODIL-3050?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18034234#comment-18034234
]
Steve Lawrence commented on DAFFODIL-3050:
------------------------------------------
We do have this page https://daffodil.apache.org/tunables/
Though it's manually updated and I don't think it has been updated in a while.
It also isn't very discoverable--it's only linked from the
daffodil.apache.org/configuration page, and that is only linked from the
dafodil.apache.org/cli page. Tunables also aren't specific to the
CLI/configuration. We either need to link this from other pages, or come up
with some other organization that makes things kinds of things easier to
discover.
> site documentation for Daffodil tunables
> -----------------------------------------
>
> Key: DAFFODIL-3050
> URL: https://issues.apache.org/jira/browse/DAFFODIL-3050
> Project: Daffodil
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 4.0.0
> Reporter: Mike Beckerle
> Priority: Major
>
> We have doc strings in the dafext.xsd file, but we don't generate a
> daffodil-site documentation page from them, so the only way people can know
> about them is to know to look in the dafext.xsd file itself.
> In general the mechanism for assigning DFDL variables, providing settings for
> tunables, etc. is not described in our documentation, other than the CLI
> documentation for specifying a config file on the command line, and API calls
> for specifying a config file.
> For example, our warning messages come with a WarnID which can be added to
> the tunable suppressSchemaDefinitionWarnings in a config file to silence the
> warnings.
> This is important but not documented anywhere.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
