commit | ad105144ac9d1b0bf356ac69b16e0c727e07a457 | [log] [tgz] |
---|---|---|
author | John Interrante <interran@research.ge.com> | Mon May 10 23:04:25 2021 -0400 |
committer | John Interrante <interran@research.ge.com> | Tue May 11 17:15:53 2021 -0400 |
tree | a9feeebcccf0447d93b300efe8024d302aea5a2d | |
parent | d5ccc0b8d4538d1f64a24595afe4d58907c218b6 [diff] |
Update CLI help information Compare in-program CLI help information with Daffodil website's CLI documentation. Make changes to make them match each other better, such as capitalizing first word of help information, reordering help information in same order as displayed by program and website, reordering subcommands in same order as web page, and changing some words for more consistency. Also simplify CLI help in response to reviewer suggestions: - Remove confusing [{<namespace>}] from -D and -r options - Sort usage options essential first, then alphabetically - Hide -p, --path option since Daffodil allows only "/" - Clarify validation mode is not optional anymore - Rename names/testname to testnames for consistency - Add "Defaults to" in more places Note: IDEA shows many warnings for Main.scala. It would be a good idea to clean it up using IDEA's suggested fixes. Some of these warnings will need to be fixed when it's time to support Scala 3. DAFFODIL-817, DAFFODIL-2477
Apache Daffodil is an open-source implementation of the DFDL specification that uses DFDL data descriptions to parse fixed format data into an infoset. This infoset is commonly converted into XML or JSON to enable the use of well-established XML or JSON technologies and libraries to consume, inspect, and manipulate fixed format data in existing solutions. Daffodil is also capable of serializing or “unparsing” data back to the original data format. The DFDL infoset can also be converted directly to/from the data structures carried by data processing frameworks so as to bypass any XML/JSON overheads.
For more information about Daffodil, see https://daffodil.apache.org/.
See BUILD.md for more details.
SBT is the officially supported tool to build Daffodil. Below are some of the more commonly used commands for Daffodil development.
Compile source code:
sbt compile
Run unit tests:
sbt test
Run command line interface tests:
sbt IntegrationTest/test
Build the command line interface (Linux and Windows shell scripts in daffodil-cli/target/universal/stage/bin/
; see the Command Line Interface documentation for details on their usage):
sbt daffodil-cli/stage
Run Apache RAT (license audit report in target/rat.txt
and error if any unapproved licenses are found):
sbt ratCheck
Run sbt-scoverage (report in target/scala-ver/scoverage-report/
):
sbt clean coverage test IntegrationTest/test sbt coverageAggregate
You can ask questions on the dev@daffodil.apache.org or users@daffodil.apache.org mailing lists. You can report bugs via the Daffodil JIRA.
Apache Daffodil is licensed under the Apache License, v2.0.