Merge pull request #13287 from ethereum/bettercmdlineHelp

Document in ``solc --help`` usage of ``--metadata`` better.
This commit is contained in:
Mathias L. Baumann 2022-08-18 13:00:33 +02:00 committed by GitHub
commit 86ab18c9af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -565,7 +565,7 @@ General Information)").c_str(),
( (
(g_strOutputDir + ",o").c_str(), (g_strOutputDir + ",o").c_str(),
po::value<string>()->value_name("path"), po::value<string>()->value_name("path"),
"If given, creates one file per component and contract/file at the specified directory." "If given, creates one file per output component and contract/file at the specified directory."
) )
( (
g_strOverwrite.c_str(), g_strOverwrite.c_str(),
@ -718,7 +718,7 @@ General Information)").c_str(),
(CompilerOutputs::componentName(&CompilerOutputs::signatureHashes).c_str(), "Function signature hashes of the contracts.") (CompilerOutputs::componentName(&CompilerOutputs::signatureHashes).c_str(), "Function signature hashes of the contracts.")
(CompilerOutputs::componentName(&CompilerOutputs::natspecUser).c_str(), "Natspec user documentation of all contracts.") (CompilerOutputs::componentName(&CompilerOutputs::natspecUser).c_str(), "Natspec user documentation of all contracts.")
(CompilerOutputs::componentName(&CompilerOutputs::natspecDev).c_str(), "Natspec developer documentation of all contracts.") (CompilerOutputs::componentName(&CompilerOutputs::natspecDev).c_str(), "Natspec developer documentation of all contracts.")
(CompilerOutputs::componentName(&CompilerOutputs::metadata).c_str(), "Combined Metadata JSON whose Swarm hash is stored on-chain.") (CompilerOutputs::componentName(&CompilerOutputs::metadata).c_str(), "Combined Metadata JSON whose IPFS hash is stored on-chain.")
(CompilerOutputs::componentName(&CompilerOutputs::storageLayout).c_str(), "Slots, offsets and types of the contract's state variables.") (CompilerOutputs::componentName(&CompilerOutputs::storageLayout).c_str(), "Slots, offsets and types of the contract's state variables.")
; ;
desc.add(outputComponents); desc.add(outputComponents);