You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by "olabusayoT (via GitHub)" <gi...@apache.org> on 2024/10/15 22:28:32 UTC
[PR] Updated Configuration and added Tunables documentation [daffodil-site]
olabusayoT opened a new pull request, #148:
URL: https://github.com/apache/daffodil-site/pull/148
- 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Updated Configuration and added Tunables documentation [daffodil-site]
Posted by "stevedlawrence (via GitHub)" <gi...@apache.org>.
stevedlawrence commented on code in PR #148:
URL: https://github.com/apache/daffodil-site/pull/148#discussion_r1803242191
##########
site/tunables.md:
##########
@@ -0,0 +1,387 @@
+---
+layout: page
+title: DFDL Tunables
+group: nav-right
+---
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+<!--
+{% comment %}
+This file is generated using ``sbt genTunablesDoc``. Update that task in Daffodil to update this file.
+{% endcomment %}
+-->
+
+Daffodil provides tunables as a way to change its behavior.
+Tunables are set by way of the ``tunables`` element in [config files](/configuration)
+or from the [cli](/cli) via the ``-T`` option.
+
+#### Config Example
+ ``` xml
+ <daf:dfdlConfig
+ xmlns:daf="urn:ogf:dfdl:2013:imp:daffodil.apache.org:2018:ext">
+ <daf:tunables>
+ <daf:suppressSchemaDefinitionWarnings>
+ encodingErrorPolicyError
+ </daf:suppressSchemaDefinitionWarnings>
+ </daf:tunables>
+</daf:dfdlConfig>
+ ```
+
+ The config file can then be passed into daffodil subcommands via the ``-c|--config`` options.
+
+#### CLI Example
+ ``` bash
+ daffodil parse -s schema.xsd -TsuppressSchemaDefinitionWarnings="encodingErrorPolicyError" data.bin
+ ```
+
+
+### Definitions
+
+#### allowBigIntegerBits
+
+ Previous Daffodil releases let schemas define every type's length using "bits" as the length unit
+ even though the specification allows bit length units only for a specific set of types' binary
+ representations and does not allow bit length units for any other type's binary representation
+ or any type's text representation. When this tunable is true, a deprecation warning is issued
+ when bit length units are incorrectly used. When this tunable is false, a schema definition
+ error will be issued instead.
+
+
+
+#### allowExpressionResultCoercion
+
+ Defines how Daffodil coerces expressions where the result type differs
+ from the expected type. As an example, assume the expected type of an
+ expression is an xs:string, but the expression is { 3 }. In this case, the
+ expression result is an xs:int, which should not be automatically coerced
+ to an xs:string. Instead, the expression should be { xs:string(3) } or { "3" }
+ If the value of this tunable is false, these types of expressions will
+ result in a schema definition error. If the value is true, Daffodil will
+ provide a warning and attempt to coerce the result type to the expected
+ type.
Review Comment:
These are all indented which makes them show up as code blocks in the generated html. This isn't really code, probably just wants to be normal text.
##########
site/tunables.md:
##########
@@ -0,0 +1,387 @@
+---
+layout: page
+title: DFDL Tunables
Review Comment:
This title probably wants to be `Daffodil Tunables` or maybe just `Tunables` since this being on daffodil.apache.org implies it's about Daffodil.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Updated Configuration and added Tunables documentation [daffodil-site]
Posted by "olabusayoT (via GitHub)" <gi...@apache.org>.
olabusayoT merged PR #148:
URL: https://github.com/apache/daffodil-site/pull/148
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org