Merge branch 'develop' into release

CMakeLists.txt

@@ -28,7 +28,7 @@ include(EthPolicy)
 eth_policy()
 
 # project name and version should be set after cmake_policy CMP0048
-project(cpp-ethereum VERSION "1.2.4")
+project(cpp-ethereum VERSION "1.2.5")
 
 include(EthCompilerSettings)
 

CodingStandards.txt

@@ -1,12 +1,11 @@
 0. Formatting
 
+GOLDEN RULE: Follow the style of the existing code when you make changes.
 
-GOLDEN RULE: Never *ever* use spaces for formatting.
-
-a. Use tabs for indentation!
+a. Use tabs for leading indentation
 - tab stops are every 4 characters.
 - One indentation level -> exactly one byte (i.e. a tab character) in the source file.
-- Never use spaces to line up sequential lines: If you have run-on lines, indent as you would for a block.
+- If you have run-on lines, indent as you would for a block.
 b. Line widths:
 - Don't worry about having lines of code > 80-char wide.
 - Lines of comments should be formatted according to ease of viewing, but simplicity is to be prefered over beauty.
@@ -60,8 +59,6 @@ std::tuple<float, float> meanAndSigma(std::vector<float> const& _v);
 2. Preprocessor;
 
 a. File comment is always at top, and includes:
-- Original author, date.
-- Later maintainers (not contributors - they can be seen through VCS log).
 - Copyright.
 - License (e.g. see COPYING).
 b. Never use #ifdef/#define/#endif file guards. Prefer #pragma once as first line below file comment.
@@ -179,7 +176,7 @@ a. Collection conventions:
 b. Class conventions:
 - -Face means the interface of some shared concept. (e.g. FooFace might be a pure virtual class.)
 c. Avoid unpronouncable names;
-- If you need to shorten a name favour a pronouncable slice of the original to a scatterred set of consonants.
+- If you need to shorten a name favour a pronouncable slice of the original to a scattered set of consonants.
 - e.g. Manager shortens to Man rather than Mgr.
 d. Avoid prefixes of initials (e.g. DON'T use IMyInterface, CMyImplementation)
 e. Find short, memorable & (at least semi-) descriptive names for commonly used classes or name-fragments.
@@ -201,6 +198,7 @@ c. Where there are exceptions to this (due to excessive use and clear meaning),
 d. In general expressions should be roughly as important/semantically meaningful as the space they occupy.
 
 
+
 11. Commenting
 
 a. Comments should be doxygen-compilable, using @notation rather than \notation.
@@ -228,6 +226,8 @@ a. Includes should go in order of lower level (STL -> boost -> libdevcore -> lib
 
 b. The only exception to the above rule is the top of a .cpp file where its corresponding header should be located.
 
+
+
 13. Logging
 
 Logging should be performed at appropriate verbosities depending on the logging message.
@@ -239,3 +239,17 @@ Some rules to keep in mind:
  - Verbosity >= 2 -> Anything that is or might be displayed more than once every minute
  - Verbosity >= 3 -> Anything that only a developer would understand
  - Verbosity >= 4 -> Anything that is low-level (e.g. peer disconnects, timers being cancelled)
+
+
+14. Recommended reading
+
+Herb Sutter and Bjarne Stroustrup
+- "C++ Core Guidelines" (https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md)
+
+Herb Sutter and Andrei Alexandrescu
+- "C++ Coding Standards: 101 Rules, Guidelines, and Best Practices"
+
+Scott Meyers
+- "Effective C++: 55 Specific Ways to Improve Your Programs and Designs (3rd Edition)"
+- "More Effective C++: 35 New Ways to Improve Your Programs and Designs"
+- "Effective Modern C++: 42 Specific Ways to Improve Your Use of C++11 and C++14"

dependency_graph/generate.py

@@ -99,7 +99,7 @@ def processSubmodule(root, submodule):
 
     # Mix doesn't have the same sub-module structure as everything else
     if (submodule == "mix"):
-        print 'Mix\n'
+        print '"Mix-ide"\n'
     else:
         print getLibraryAndApplicationNames(submodulePath)
 

recreate-cpp-ethereum.sh

@@ -0,0 +1,116 @@
+#!/usr/bin/env bash
+#
+# Script to recreate the cpp-ethereum repository by copying directories from webthree-umbrella.
+#
+# This is for one step of the "Dry run for repository reorganization" which is to get the content
+# correct, automated and tested, before pulling the trigger on the real move, which will need to
+# preserve history.
+#
+# See https://github.com/ethereum/webthree-umbrella/issues/453
+
+outputDirectory=../cpp-ethereum-recreated
+
+rm    -rf $outputDirectory
+mkdir -p  $outputDirectory
+mkdir -p  $outputDirectory/test/
+
+# alethzero intentionally omitted
+rsync -r ./dependency_graph/              $outputDirectory/dependency_graph/
+rsync -r ./doc/                           $outputDirectory/doc/
+rsync -r ./docker/                        $outputDirectory/docker/
+rsync -r ./libethereum/ethkey/            $outputDirectory/ethkey/
+rsync -r ./libethereum/ethminer/          $outputDirectory/ethminer/
+rsync -r ./libethereum/ethvm/             $outputDirectory/ethvm/
+rsync -r ./libethereum/libethash/         $outputDirectory/libethash/
+rsync -r ./libethereum/libethash-cl/      $outputDirectory/libethash-cl/
+rsync -r ./libethereum/libethashseal/     $outputDirectory/libethashseal/
+rsync -r ./libethereum/libethcore/        $outputDirectory/libethcore/
+rsync -r ./libethereum/libethereum/       $outputDirectory/libethereum/
+rsync -r ./libethereum/libevm/            $outputDirectory/libevm/
+rsync -r ./libethereum/libevmcore/        $outputDirectory/libevmcore/
+rsync -r ./libethereum/libnatspec/        $outputDirectory/libnatspec/
+rsync -r ./libethereum/libtestutils/      $outputDirectory/libtestutils/
+rsync -r ./libethereum/test/deprecated/             $outputDirectory/test/deprecated/
+rsync -r ./libethereum/test/external-dependencies/  $outputDirectory/test/external-dependencies/
+rsync -r ./libethereum/test/fuzzTesting/            $outputDirectory/test/fuzzTesting/
+rsync -r ./libethereum/test/libethcore/             $outputDirectory/test/libethcore/
+rsync -r ./libethereum/test/libethereum/            $outputDirectory/test/libethereum/
+rsync -r ./libethereum/test/libevm/                 $outputDirectory/test/libevm/
+rsync -r ./libethereum/test/libnatspec/             $outputDirectory/test/libnatspec/
+rsync -r ./libethereum/test/libweb3core/            $outputDirectory/test/libweb3core/
+rsync -r ./libethereum/test/BlockChainHelper.cpp    $outputDirectory/test/BlockChainHelper.cpp
+rsync -r ./libethereum/test/BlockChainHelper.h      $outputDirectory/test/BlockChainHelper.h
+rsync -r ./libethereum/test/boostTest.cpp           $outputDirectory/test/boostTest.cpp
+rsync -r ./libethereum/test/JSON_test.sol           $outputDirectory/test/JSON_test.sol
+rsync -r ./libethereum/test/JsonSpiritHeaders.h     $outputDirectory/test/JsonSpiritHeaders.h
+rsync -r ./libethereum/test/Stats.cpp               $outputDirectory/test/Stats.cpp
+rsync -r ./libethereum/test/Stats.h                 $outputDirectory/test/Stats.h
+rsync -r ./libethereum/test/TestHelper.cpp          $outputDirectory/test/TestHelper.cpp
+rsync -r ./libethereum/test/TestHelper.h            $outputDirectory/test/TestHelper.h
+rsync -r ./libethereum/test/TestUtils.cpp           $outputDirectory/test/TestUtils.cpp
+rsync -r ./libethereum/test/TestUtils.h             $outputDirectory/test/TestUtils.h
+rsync -r ./libweb3core/bench/             $outputDirectory/bench/
+rsync -r ./libweb3core/libdevcore/        $outputDirectory/libdevcore/
+rsync -r ./libweb3core/libdevcrypto/      $outputDirectory/libdevcrypto/
+rsync -r ./libweb3core/libp2p/            $outputDirectory/libp2p/
+rsync -r ./libweb3core/rlp/               $outputDirectory/rlp/
+rsync -r ./libweb3core/test/libdevcore/   $outputDirectory/test/libdevcore/
+rsync -r ./libweb3core/test/libdevcrypto/ $outputDirectory/test/libdevcrypto/
+rsync -r ./libweb3core/test/libp2p/       $outputDirectory/test/libp2p/
+rsync -r ./libweb3core/test/memorydb.cpp  $outputDirectory/test/memorydb.cpp
+rsync -r ./libweb3core/test/overlaydb.cpp $outputDirectory/test/overlaydb.cpp
+# libweb3core/test/test.cpp and test.h intentionally omitted because they clash with boosttest.cpp from libethereum/test.
+# mix intentionally omitted
+# res intentionally omitted
+# solidity intentionally omitted
+# web3.js intentionally omitted
+rsync -r ./webthree/eth/                  $outputDirectory/eth/
+rsync -r ./webthree/libweb3jsonrpc/       $outputDirectory/libweb3jsonrpc/
+rsync -r ./webthree/libwebthree/          $outputDirectory/libwebthree/
+rsync -r ./webthree/libwhisper/           $outputDirectory/libwhisper/
+rsync -r ./webthree/test/ethrpctest/      $outputDirectory/test/ethrpctest/
+rsync -r ./webthree/test/libweb3jsonrpc/  $outputDirectory/test/libweb3jsonrpc/
+rsync -r ./webthree/test/libwhisper/      $outputDirectory/test/libwhisper/
+rsync -r ./webthree-helpers/cmake/        $outputDirectory/cmake/
+rsync -r ./webthree-helpers/extdep/       $outputDirectory/extdep/
+rsync -r ./webthree-helpers/homebrew/     $outputDirectory/homebrew/
+rsync -r ./webthree-helpers/js/           $outputDirectory/js/
+rsync -r ./webthree-helpers/scripts/      $outputDirectory/scripts/
+rsync -r ./webthree-helpers/templates/    $outputDirectory/templates/
+rsync -r ./webthree-helpers/utils/        $outputDirectory/utils/
+# intentionally left /webthree-helpers root files behind: (LICENSE, new.sh, README.md)
+# TODO /webthree-helpers/cmake has (LICENSE, README.md), but why?
+# TODO /webthree-helpers/homebrew has (LICENSE, README.md), but why?
+# Tried unsuccessfully to delete homebrew ones.   Needed in some release flow?
+
+# Loose files in the root directory of webthree-umbrella.
+# TODO - Move all these loose scripts in the root into /scripts
+# CMakeLists.txt intentionally omitted.
+rsync -r ./CodingStandards.txt            $outputDirectory/CodingStandards.txt
+rsync -r ./CONTRIBUTING.md                $outputDirectory/CONTRIBUTING.md
+rsync -r ./GPLV3_LICENSE                  $outputDirectory/GPLV3_LICENSE
+rsync -r ./LICENSE                        $outputDirectory/LICENSE
+# qtcreator-style intentionally omitted.
+# README.md intentionally omitted.
+rsync -r ./sanitizer-blacklist.txt        $outputDirectory/sanitizer-blacklist.txt
+rsync -r ./sync.sh                        $outputDirectory/sync.sh
+
+# These files cannot be upstreamed, but instead need to be manually maintained and then dropped into 'cpp-ethereum' when we merge.
+# These CMakeLists.txt were manually synthesized by Bob.
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/cmake/EthOptions.cmake > $outputDirectory/cmake/EthOptions.cmake
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/CMakeLists.txt > $outputDirectory/CMakeLists.txt
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/README.md > $outputDirectory/README.md
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/test/CMakeLists.txt > $outputDirectory/test/CMakeLists.txt
+
+# These files could be upstreamed, but it isn't worth doing so, because they can only be used after the repo reorganization.
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/.travis.yml > $outputDirectory/.travis.yml
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/appveyor.yml > $outputDirectory/appveyor.yml
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/circle.yml > $outputDirectory/circle.yml
+curl https://raw.githubusercontent.com/bobsummerwill/cpp-ethereum/merge_repos/setup.sh > $outputDirectory/setup.sh
+
+# TODO - evmjit submodule will need "hooking up", for now we'll just git clone it into a local directory to get
+# the content we need for testing.
+git clone https://github.com/ethereum/evmjit $outputDirectory/evmjit
+
+# TODO - Move Contributing and coding standards to http://ethdocs.org
+# TODO - Where will qtcreator-style go?   Ditto for res folder.