daffodil-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [daffodil-site] tuxji commented on a change in pull request #64: Update CLI documentation for Daffodil 3.1.0
Date Mon, 10 May 2021 12:56:12 GMT

tuxji commented on a change in pull request #64:
URL: https://github.com/apache/daffodil-site/pull/64#discussion_r629304939



##########
File path: site/cli.md
##########
@@ -26,7 +26,7 @@ The binary Daffodil [releases](/releases) contain a ``/bin`` directory that
cont
 
     daffodil [GLOBAL_OPTIONS] <subcommand> [SUBCOMMAND_OPTIONS]
 
-The available subcommands are: [parse](#parse-subcommand), [unparse](#unparse-subcommand),
[save-parser](#save-parser-subcommand), [test](#test-subcommand), and [performance](#performance-subcommand).
+The available subcommands are: [parse](#parse-subcommand), [unparse](#unparse-subcommand),
[save-parser](#save-parser-subcommand), [test](#test-subcommand), [performance](#performance-subcommand),
and [generate][#generate-subcommand].

Review comment:
       Thanks for the catch and I agree, let's convert to bullets.

##########
File path: site/cli.md
##########
@@ -44,6 +44,10 @@ Setting environment variables may be necessary to allow for importing/includes
t
 
    : If you need to specify java options specific to Daffodil, you can set the ``DAFFODIL_JAVA_OPTS``
environment variable. If not specified, the ``JAVA_OPTS`` environment variable will be used.
If that is not specified, reasonable defaults for Daffodil will be used.
 
+``CC``
+
+   : If you need to specify which C compiler Daffodil's runtime2 backend should call when
running TDML files, you can set the ``CC`` environment variable. If that environment variable
is not specified, then `cc` will be used as the default driver command for compiling C source
files from TDML files.

Review comment:
       I like your suggestion and incorporated it.  Correct, the generate subcommand doesn't
compile after generating code.  I also remembered that I should mention that Daffodil will
pick the first driver command it finds within the PATH environment variable from a list (zig
cc, cc, clang, gcc) and that zig cc comes first because it uses a caching system.
   
   BTW, we don't need to use a pair of left quotation marks to begin inline code spans and
end them with another pair of left quotation marks.  A single left quotation mark will work
too; the reason for allowing N left quotation marks is to allow consecutive N-1 left quotation
marks to be used inside the text being quoted.

##########
File path: site/cli.md
##########
@@ -192,19 +200,24 @@ Unparse an infoset file, using either a DFDL schema or a saved parser.
 
    : Split the input data at NUL characters and unparse each chunk separately to the same
output file.
 
+``--nostream``
+
+   : Treat the entire input data as one infoset. This is the default behavior.
+
 ``-T TUNABLE=VALUE``
 
-   : Modify Daffodil configuration options to change parsing behavior. See [Configuration](/configuration)
for the list of tunable parameters.
+   : Modify Daffodil configuration options to change unparsing behavior. See [Configuration](/configuration)
for the list of tunable parameters.
 
 ``-V, --validate [MODE]``
 
-  : The validation mode. ``MODE`` must be one of ``on``, ``limited`` or ``off``. If ``MODE``
is not provided, defaults to ``on``. If ``--validate`` is not provided, defaults to ``off``.
``MODE`` cannot be ``on`` when used with the ``--parser`` option.
+   : The validation mode. ``MODE`` must be one of ``on``, ``limited`` or ``off``. If ``MODE``
is not provided, defaults to ``on``. If ``--validate`` is not provided, defaults to ``off``.
``MODE`` cannot be ``on`` when used with the ``--parser`` option.

Review comment:
       @jw3, you can take advantage of the branch I pushed (even though it wasn't standard
operating procedure) and push your own change to it so we can review your change in the same
PR too.




-- 
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message