aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2018-02-27 07:36:01 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2018-02-27 07:36:01 +0800
commit241134a8816fbd832ab60ccd7aecc70ba00e8ac3 (patch)
tree9fe603189ea333d99a5919fba3c56497a7416f91 /docs
parent1f5eb4ba59891387c2dfcc10103c2f187bf2b4ee (diff)
downloaddexon-solidity-241134a8816fbd832ab60ccd7aecc70ba00e8ac3.tar.gz
dexon-solidity-241134a8816fbd832ab60ccd7aecc70ba00e8ac3.tar.zst
dexon-solidity-241134a8816fbd832ab60ccd7aecc70ba00e8ac3.zip
Mention that solcjs is not compatible with solc in the using-the-compiler section
Diffstat (limited to 'docs')
-rw-r--r--docs/installing-solidity.rst2
-rw-r--r--docs/using-the-compiler.rst3
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst
index 8f30f199..8c445e5e 100644
--- a/docs/installing-solidity.rst
+++ b/docs/installing-solidity.rst
@@ -29,6 +29,8 @@ Further options on this page detail installing commandline Solidity compiler sof
on your computer. Choose a commandline compiler if you are working on a larger contract
or if you require more compilation options.
+.. _solcjs:
+
npm / Node.js
=============
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
index 42cc807a..66e3ac35 100644
--- a/docs/using-the-compiler.rst
+++ b/docs/using-the-compiler.rst
@@ -9,6 +9,9 @@ Using the compiler
Using the Commandline Compiler
******************************
+.. note::
+ This section doesn't apply to :ref:`solcjs <solcjs>`.
+
One of the build targets of the Solidity repository is ``solc``, the solidity commandline compiler.
Using ``solc --help`` provides you with an explanation of all options. The compiler can produce various outputs, ranging from simple binaries and assembly over an abstract syntax tree (parse tree) to estimations of gas usage.
If you only want to compile a single file, you run it as ``solc --bin sourceFile.sol`` and it will print the binary. Before you deploy your contract, activate the optimizer while compiling using ``solc --optimize --bin sourceFile.sol``. If you want to get some of the more advanced output variants of ``solc``, it is probably better to tell it to output everything to separate files using ``solc -o outputDirectory --bin --ast --asm sourceFile.sol``.