Skip to content

Commit

Permalink
Update usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dmuhs committed Mar 18, 2020
1 parent 93b54f6 commit 2d3da0a
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,24 +125,25 @@ the number of false positive issues. The MythX CLI will try to infer the
:code:`solc` version based on the pragma set in the source code. An explicit
compiler version can be specified with the :code:`--solc-version` flag.

By default, the MythX CLI submits an analysis request for each contract it
encounters. Depending on the project layout, this can result in duplicate
submission of source code (e.g. when all code is flattened in a single file).
To avoid this issue, the :code:`--include` parameter can be passed multiple
times to specify the contracts that are the target of this submission.
By default, the MythX CLI will submit the bytecode of the target contract
(if specified), and add the source code and AST information of its
dependencies to the request.
This can result in duplicate submission of source code (e.g. when all code
is flattened in a single file). To avoid this issue, the :code:`--include`
parameter can be passed multiple times to specify the contracts that are
the target of this submission.

.. code-block:: console
$ mythx analyze --include EstateRegistry --include LANDRegistry --include LANDStorage
This will effectively whitelist the specified contract names and exclude every
other contract from submission. Please note that this option is case sensitive.
If a contract name cannot be found in the project, an error is thrown.
Please note that this option is case sensitive. If the contract's name cannot
be found in the project, an error is thrown.

Alternatively, if you are passing specific Solidity files as arguments to the
:code:`analyze` subcommand, you can also specify the contract name to submit
separated by a colon from the file path. E.g.
Alternatively, if specific Solidity files are passed as arguments to the
:code:`analyze` subcommand, the contract name to submit can also be specified
by separating it with a colon from the source file path. E.g.

.. code-block:: console
Expand Down

0 comments on commit 2d3da0a

Please sign in to comment.