Better command line in rlp by demon1999 · Pull Request #4639 · ethereum/aleth

demon1999 · 2017-10-31T05:38:42Z

No description provided.

chfast

Sorry for delays in reviews. Everyone is on devcon3.

chfast · 2017-11-02T20:12:21Z

rlp/main.cpp

 			otherInputs.push_back(arg);
 	}
+	if (vm.count("help")) {
+		cout << "Usage rlp <mode> [OPTIONS]" << endl << modesOptions


I'm not expert here, but shouldn't the program_options be able to output that for us?

codecov-io · 2017-11-03T04:50:54Z

Codecov Report

Merging #4639 into develop will increase coverage by 0.18%.
The diff coverage is 0%.

@@             Coverage Diff             @@
##           develop    #4639      +/-   ##
===========================================
+ Coverage     60.9%   61.09%   +0.18%     
===========================================
  Files          343      343              
  Lines        26999    27089      +90     
  Branches      2765     2779      +14     
===========================================
+ Hits         16444    16550     +106     
+ Misses        9603     9569      -34     
- Partials       952      970      +18

Impacted Files	Coverage Δ
rlp/main.cpp	`0% <0%> (ø)`	⬆️
libethashseal/EthashProofOfWork.h	`80% <0%> (-20%)`	⬇️
libethereum/Transaction.h	`53.84% <0%> (-18.38%)`	⬇️
libethereum/Executive.h	`52.17% <0%> (-14.5%)`	⬇️
libethereum/Account.h	`80% <0%> (-14.12%)`	⬇️
libethcore/LogEntry.h	`44% <0%> (-13.9%)`	⬇️
libdevcrypto/Common.h	`73.33% <0%> (-12.39%)`	⬇️
libevm/VM.h	`58.82% <0%> (-9.93%)`	⬇️
libdevcore/CommonJS.h	`90.32% <0%> (-9.68%)`	⬇️
utils/json_spirit/json_spirit_value.h	`57.52% <0%> (-9.15%)`	⬇️
... and 40 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2cf4e7c...7072fd4. Read the comment docs.

gumb0

Ok, the help output looks a little weird now:

Usage rlp <mode> [OPTIONS]
Modes:
  -i [ --indent ] arg   <string>  Use string as the level indentation (default
                        '  ').
  --hex-ints            Render integers in hex.
  --string-ints         Render integers in the same way as strings.
  --ascii-strings       Render data as C-style strings or hex depending on
                        content being ASCII.
  --force-string        Force all data to be rendered as C-style strings.
  --force-escape        When rendering as C-style strings, force all characters
                        to be escaped.
  --force-hex           Force all data to be rendered as raw hex.
  -D [ --dapp ]         Dapp-building mode; equivalent to --encrypt --64.
    create <json>  Given a simplified JSON string, output the RLP.
    render [ <file> | -- ]  Render the given RLP. Options:
    list [ <file> | -- ]  List the items in the RLP list by hash and size.
    extract [ <file> | -- ]  Extract all items in the RLP list, named by hash.
    assemble [ <manifest> | <base path> ] <file> ...  Given a manifest & files, output the RLP.
General options:
  -e [ --encrypt ]      Encrypt the RLP data prior to output.
  -L [ --lenience ]     Try not to bomb out early if possible.
  -x [ --hex ]          Treat input RLP as hex encoded data.
  --base-16             Treat input RLP as hex encoded data.
  -k [ --keccak ]       Output Keccak-256 hash only.
  --base-64             Treat input RLP as base-64 encoded data.
  --64                  Treat input RLP as base-64 encoded data.
  -b [ --bin ]          Treat input RLP as raw binary data.
  --base-256            Treat input RLP as raw binary data.
  -q [ --quiet ]        Don't place additional information on stderr.
  -h [ --help ]         Print this help message and exit.
  -V [ --version ]      Show the version and exit.

We should figure out how to make it better, modes (create, render, list, extract, assemble) should be on the top, after Modes:
The options on top I think make sense for the render mostly, so maybe they should have title "Render Options"

Also please move -D into General options, because it's a combination of two other general options, I think it fits there better

gumb0 · 2017-11-28T14:48:51Z

rlp/main.cpp

+		prefs.escapeAll = true;
+	if (vm.count("nice"))
+		prefs.forceString = true, prefs.stringInts = false, prefs.forceHex = false, prefs.indent = "  ";
+	if (vm.count("lenience"))


Here's the duplicated piece of code from lenience till encrypt

gumb0 · 2017-11-28T15:04:47Z

What if we change it to rlp --mode=<mode>, would it be easier to make help output look better and could we then get rid of handling unrecognized options?

The challenge might be in different modes having different number of arguments following them (like assemble has arbitrary number of files)

Check out also "positional options". maybe it helps somehow http://www.boost.org/doc/libs/1_58_0/doc/html/program_options/tutorial.html#idp337627504

gumb0 · 2017-11-29T13:50:32Z

What happened to the indentation? Looks like it all changed to spaces

demon1999 · 2017-11-29T19:16:17Z

It's my fault. I'll fix it

gumb0

Also further please use more descriptive commit messages than "Update main.cpp"

gumb0 · 2017-11-29T20:52:00Z

rlp/main.cpp

-	case Encoding::Keccak:
-		cout << sha3(_out).hex() << endl;
-		break;
+		case Encoding::Hex: case Encoding::Auto:


Don't change the indentation of casess inside switches, I just fixed it before in my commit here

gumb0 · 2017-11-29T20:52:20Z

rlp/main.cpp

@@ -1,16 +1,13 @@
 /*
 	This file is part of cpp-ethereum.
-


Don't remove these empty lines in comments

chfast · 2017-12-01T16:58:37Z

CMakeLists.txt


-hunter_add_package(Boost COMPONENTS filesystem system thread)
-find_package(Boost CONFIG REQUIRED filesystem system thread)
+hunter_add_package(Boost COMPONENTS program_options filesystem system thread)


Hasn't this been merged to develop already?

chfast · 2017-12-01T17:04:21Z

rlp/main.cpp

+			 << renderOptions << generalOptions;
+		exit(0);
+	}
+	if (vm.count("lenience"))


This seems to be a weird way of doing this. Can't we inform boost we would like to store this option in bool lenience variable and use the variable directly?

This is the way suggested by the official tutorials http://www.boost.org/doc/libs/1_65_1/doc/html/program_options/tutorial.html#idp437555840
But there's an option to store it in a local variable, too, I think.

This way is actually more compact (no need to define a local variable for each option), but duplicating the option name is a downside

chfast · 2017-12-06T14:01:07Z

Rebase and merge?

gumb0 · 2017-12-06T16:00:39Z

I'll rebase it

fixing rlp

fixing formating

…ort them

…ing.

chfast reviewed Nov 2, 2017

View reviewed changes

gumb0 self-requested a review November 23, 2017 16:50

gumb0 force-pushed the developrlp branch from 1e3c084 to d7ff6fd Compare November 28, 2017 14:24

gumb0 suggested changes Nov 28, 2017

View reviewed changes

gumb0 suggested changes Nov 29, 2017

View reviewed changes

gumb0 approved these changes Nov 30, 2017

View reviewed changes

gumb0 mentioned this pull request Nov 30, 2017

Better command line in ethkey and eth #4635

Merged

chfast reviewed Dec 1, 2017

View reviewed changes

demon1999 and others added 13 commits December 6, 2017 17:22

Fixing cmakelists

df87859

Fixing rlp

511703b

Fixing codestyle in rlp

0bbeefb

Fixing rlp

0bb031b

Fix formatting

68a3b63

Update main.cpp

d7d415e

Update main.cpp

2627353

fixing rlp

Update main.cpp

e39a450

Update main.cpp

e5d3d71

fixing formating

Fix formatting

50b83f5

Remove long aliases for options as boost.program_options doesn't supp…

c697003

…ort them

Add default value to -i. Catch exceptions during program options pars…

6078814

…ing.

Remove obsolete --nice option handling.

7072fd4

gumb0 force-pushed the developrlp branch from bd5cf49 to 7072fd4 Compare December 6, 2017 16:23

gumb0 merged commit 40c7ceb into ethereum:develop Dec 7, 2017

Conversation

demon1999 commented Oct 31, 2017

Uh oh!

chfast left a comment

Choose a reason for hiding this comment

Uh oh!

chfast Nov 2, 2017

Choose a reason for hiding this comment

Uh oh!

demon1999 Nov 3, 2017

Choose a reason for hiding this comment

Uh oh!

codecov-io commented Nov 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gumb0 left a comment

Choose a reason for hiding this comment

Uh oh!

gumb0 Nov 28, 2017

Choose a reason for hiding this comment

Uh oh!

gumb0 commented Nov 28, 2017

Uh oh!

gumb0 commented Nov 29, 2017

Uh oh!

demon1999 commented Nov 29, 2017

Uh oh!

gumb0 left a comment

Choose a reason for hiding this comment

Uh oh!

gumb0 Nov 29, 2017

Choose a reason for hiding this comment

Uh oh!

gumb0 Nov 29, 2017

Choose a reason for hiding this comment

Uh oh!

chfast Dec 1, 2017

Choose a reason for hiding this comment

Uh oh!

chfast Dec 1, 2017

Choose a reason for hiding this comment

Uh oh!

gumb0 Dec 6, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chfast commented Dec 6, 2017

Uh oh!

gumb0 commented Dec 6, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-io commented Nov 3, 2017 •

edited

Loading

gumb0 Dec 6, 2017 •

edited

Loading