aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.travis.yml2
-rw-r--r--CONTRIBUTING.md5
-rw-r--r--cmake/EthBuildInfo.cmake4
-rw-r--r--cmake/scripts/buildinfo.cmake53
-rw-r--r--cmake/templates/BuildInfo.h.in15
-rw-r--r--docs/contributing.rst52
-rw-r--r--docs/index.rst1
-rw-r--r--docs/installing-solidity.rst6
-rw-r--r--libsolidity/interface/Version.cpp6
-rwxr-xr-xscripts/build_emscripten.sh1
-rwxr-xr-xscripts/release_ppa.sh4
11 files changed, 115 insertions, 34 deletions
diff --git a/.travis.yml b/.travis.yml
index 1b0ff15d..da9bd2f9 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -141,6 +141,8 @@ cache:
install:
- test $TRAVIS_INSTALL_DEPS != On || ./scripts/install_deps.sh
+ - echo -n "$TRAVIS_COMMIT" > commit_hash.txt
+ - test "$TRAVIS_PULL_REQUESTS" != "false" || test "$TRAVIS_BRANCH" != release || echo -n > prerelease.txt # this is a proper release
before_script:
- test $TRAVIS_EMSCRIPTEN != On || ./scripts/build_emscripten.sh
- test $TRAVIS_RELEASE != On || (mkdir -p build
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..2b591f4e
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Contribution Guidelines
+
+Please see our contribution guidelines in [the Solidity documentation](http://solidity.readthedocs.io/en/latest/contributing.html).
+
+Thank you for your help!
diff --git a/cmake/EthBuildInfo.cmake b/cmake/EthBuildInfo.cmake
index cbb9dd24..1f70d371 100644
--- a/cmake/EthBuildInfo.cmake
+++ b/cmake/EthBuildInfo.cmake
@@ -19,7 +19,7 @@ function(create_build_info NAME)
set(ETH_BUILD_COMPILER "unknown")
endif ()
- set(ETH_BUILD_PLATFORM "${ETH_BUILD_OS}/${ETH_BUILD_COMPILER}")
+ set(ETH_BUILD_PLATFORM "${ETH_BUILD_OS}.${ETH_BUILD_COMPILER}")
#cmake build type may be not speCified when using msvc
if (CMAKE_BUILD_TYPE)
@@ -36,8 +36,6 @@ function(create_build_info NAME)
-DETH_BUILD_OS="${ETH_BUILD_OS}"
-DETH_BUILD_COMPILER="${ETH_BUILD_COMPILER}"
-DETH_BUILD_PLATFORM="${ETH_BUILD_PLATFORM}"
- -DETH_BUILD_NUMBER="${BUILD_NUMBER}"
- -DETH_VERSION_SUFFIX="${VERSION_SUFFIX}"
-DPROJECT_VERSION="${PROJECT_VERSION}"
-P "${ETH_SCRIPTS_DIR}/buildinfo.cmake"
)
diff --git a/cmake/scripts/buildinfo.cmake b/cmake/scripts/buildinfo.cmake
index 39359486..ad23ca86 100644
--- a/cmake/scripts/buildinfo.cmake
+++ b/cmake/scripts/buildinfo.cmake
@@ -5,11 +5,11 @@
# ETH_DST_DIR - main CMAKE_BINARY_DIR
# ETH_BUILD_TYPE
# ETH_BUILD_PLATFORM
-# ETH_BUILD_NUMBER
-# ETH_VERSION_SUFFIX
#
# example usage:
-# cmake -DETH_SOURCE_DIR=. -DETH_DST_DIR=build -DETH_BUILD_TYPE=Debug -DETH_BUILD_PLATFORM=Darwin/appleclang -P scripts/buildinfo.cmake
+# cmake -DETH_SOURCE_DIR=. -DETH_DST_DIR=build -DETH_BUILD_TYPE=Debug -DETH_BUILD_PLATFORM=Darwin.appleclang -P scripts/buildinfo.cmake
+#
+# Its main output variables are SOL_VERSION_BUILDINFO and SOL_VERSION_PRERELEASE
if (NOT ETH_BUILD_TYPE)
set(ETH_BUILD_TYPE "unknown")
@@ -19,26 +19,45 @@ if (NOT ETH_BUILD_PLATFORM)
set(ETH_BUILD_PLATFORM "unknown")
endif()
-execute_process(
- COMMAND git --git-dir=${ETH_SOURCE_DIR}/.git --work-tree=${ETH_SOURCE_DIR} rev-parse HEAD
- OUTPUT_VARIABLE ETH_COMMIT_HASH OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET
-)
+# Logic here: If prereleases.txt exists but is empty, it is a non-pre release.
+# If it does not exist, create our own prerelease string
+if (EXISTS ${ETH_SOURCE_DIR}/prerelease.txt)
+ file(READ ${ETH_SOURCE_DIR}/prerelease.txt SOL_VERSION_PRERELEASE)
+ string(STRIP ${SOL_VERSION_PRERELEASE} SOL_VERSION_PRERELEASE)
+else()
+ string(TIMESTAMP SOL_VERSION_PRERELEASE "develop.%Y.%m.%d" UTC)
+endif()
-if (NOT ETH_COMMIT_HASH)
- set(ETH_COMMIT_HASH 0)
+if (EXISTS ${ETH_SOURCE_DIR}/commit_hash.txt)
+ file(READ ${ETH_SOURCE_DIR}/commit_hash.txt SOL_COMMIT_HASH)
+ string(STRIP ${SOL_COMMIT_HASH} SOL_COMMIT_HASH)
+else()
+ execute_process(
+ COMMAND git --git-dir=${ETH_SOURCE_DIR}/.git --work-tree=${ETH_SOURCE_DIR} rev-parse HEAD
+ OUTPUT_VARIABLE SOL_COMMIT_HASH OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET
+ )
+ execute_process(
+ COMMAND git --git-dir=${ETH_SOURCE_DIR}/.git --work-tree=${ETH_SOURCE_DIR} diff HEAD --shortstat
+ OUTPUT_VARIABLE SOL_LOCAL_CHANGES OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET
+ )
endif()
-execute_process(
- COMMAND git --git-dir=${ETH_SOURCE_DIR}/.git --work-tree=${ETH_SOURCE_DIR} diff HEAD --shortstat
- OUTPUT_VARIABLE ETH_LOCAL_CHANGES OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET
-)
+if (SOL_COMMIT_HASH)
+ string(STRIP ${SOL_COMMIT_HASH} SOL_COMMIT_HASH)
+ string(SUBSTRING ${SOL_COMMIT_HASH} 0 8 SOL_COMMIT_HASH)
+endif()
-if (ETH_LOCAL_CHANGES)
- set(ETH_CLEAN_REPO 0)
-else()
- set(ETH_CLEAN_REPO 1)
+if (SOL_COMMIT_HASH AND SOL_LOCAL_CHANGES)
+ set(SOL_COMMIT_HASH "${SOL_COMMIT_HASH}-mod")
+endif()
+
+if (NOT SOL_COMMIT_HASH)
+ message(FATAL_ERROR "Unable to determine commit hash. Either compile from within git repository or "
+ "supply a file called commit_hash.txt")
endif()
+set(SOL_VERSION_BUILDINFO "commit.${SOL_COMMIT_HASH}.${ETH_BUILD_PLATFORM}")
+
set(TMPFILE "${ETH_DST_DIR}/BuildInfo.h.tmp")
set(OUTFILE "${ETH_DST_DIR}/BuildInfo.h")
diff --git a/cmake/templates/BuildInfo.h.in b/cmake/templates/BuildInfo.h.in
index 6f9baf50..6c16e4ac 100644
--- a/cmake/templates/BuildInfo.h.in
+++ b/cmake/templates/BuildInfo.h.in
@@ -1,11 +1,10 @@
#pragma once
#define ETH_PROJECT_VERSION "@PROJECT_VERSION@"
-#define ETH_COMMIT_HASH @ETH_COMMIT_HASH@
-#define ETH_CLEAN_REPO @ETH_CLEAN_REPO@
-#define ETH_BUILD_TYPE @ETH_BUILD_TYPE@
-#define ETH_BUILD_OS @ETH_BUILD_OS@
-#define ETH_BUILD_COMPILER @ETH_BUILD_COMPILER@
-#define ETH_BUILD_PLATFORM @ETH_BUILD_PLATFORM@
-#define ETH_BUILD_NUMBER @ETH_BUILD_NUMBER@
-#define ETH_VERSION_SUFFIX "@ETH_VERSION_SUFFIX@"
+#define SOL_COMMIT_HASH "@SOL_COMMIT_HASH@"
+#define ETH_BUILD_TYPE "@ETH_BUILD_TYPE@"
+#define ETH_BUILD_OS "@ETH_BUILD_OS@"
+#define ETH_BUILD_COMPILER "@ETH_BUILD_COMPILER@"
+#define ETH_BUILD_PLATFORM "@ETH_BUILD_PLATFORM@"
+#define SOL_VERSION_PRERELEASE "@SOL_VERSION_PRERELEASE@"
+#define SOL_VERSION_BUILDINFO "@SOL_VERSION_BUILDINFO@"
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 00000000..32c83d8f
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,52 @@
+############
+Contributing
+############
+
+Help is always appreciated!
+
+To get started, you can try :ref:`building-from-source` in order to familiarize
+yourself with the components of Solidity and the build process. Also, it may be
+useful to become well-versed at writing smart-contracts in Solidity.
+
+In particular, we need help in the following areas:
+
+* Improving the documentation
+* Responding to questions from other users on `StackExchange
+ <http://ethereum.stackexchange.com/>`_ and the `Solidity Gitter
+ <https://gitter.im/ethereum/solidity>`_
+* Fixing and responding to `Solidity's GitHub issues
+ <https://github.com/ethereum/solidity/issues>`_
+
+How to Report Issues
+====================
+
+To report an issue, please use the
+`GitHub issues tracker <https://github.com/ethereum/solidity/issues>`_. When
+reporting issues, please mention the following details:
+
+* Which version of Solidity you are using
+* Which platform are you running on
+* How to reproduce the issue
+* What was the result of the issue
+* What the expected behaviour is
+
+Workflow for Pull Requests
+==========================
+
+In order to contribute, please fork off of the ``develop`` branch and make your
+changes there. Your commit messages should detail *why* you made your change, as
+opposed to *what* you did.
+
+If you need to pull in any changes from ``develop`` after making your fork (for
+example, to resolve potential merge conflicts), please avoid using ``git merge``
+and instead, ``git rebase`` your branch.
+
+Additionally, if you are writing a feature, please ensure you write appropriate
+Boost test cases and place them under ``test/``.
+
+Finally, please make sure you respect the `coding standards
+<https://raw.githubusercontent.com/ethereum/cpp-ethereum/develop/CodingStandards.txt>`_
+for this project. Also, even though we do CI testing, please test your code and
+ensure that it builds locally before submitting a pull request.
+
+Thank you for your help!
diff --git a/docs/index.rst b/docs/index.rst
index 5f8977e8..a5ab3f86 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -113,4 +113,5 @@ Contents
security-considerations.rst
style-guide.rst
common-patterns.rst
+ contributing.rst
frequently-asked-questions.rst
diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst
index 5111b68c..f8393f2d 100644
--- a/docs/installing-solidity.rst
+++ b/docs/installing-solidity.rst
@@ -1,3 +1,7 @@
+.. index:: ! installing
+
+.. _installing-solidity:
+
###################
Installing Solidity
###################
@@ -68,6 +72,8 @@ We will re-add the pre-built bottles soon.
brew linkapps solidity
+.. _building-from-source:
+
Building from Source
====================
diff --git a/libsolidity/interface/Version.cpp b/libsolidity/interface/Version.cpp
index a846efea..31ba4afc 100644
--- a/libsolidity/interface/Version.cpp
+++ b/libsolidity/interface/Version.cpp
@@ -35,10 +35,8 @@ char const* dev::solidity::VersionNumber = ETH_PROJECT_VERSION;
string const dev::solidity::VersionString =
string(dev::solidity::VersionNumber) +
- "-" +
- string(DEV_QUOTED(ETH_COMMIT_HASH)).substr(0, 8) +
- (ETH_CLEAN_REPO ? "" : "*") +
- "/" DEV_QUOTED(ETH_BUILD_TYPE) "-" DEV_QUOTED(ETH_BUILD_PLATFORM);
+ (string(SOL_VERSION_PRERELEASE).empty() ? "" : "-" + string(SOL_VERSION_PRERELEASE)) +
+ (string(SOL_VERSION_BUILDINFO).empty() ? "" : "+" + string(SOL_VERSION_BUILDINFO));
bytes dev::solidity::binaryVersion()
diff --git a/scripts/build_emscripten.sh b/scripts/build_emscripten.sh
index 6046978e..da2c7df3 100755
--- a/scripts/build_emscripten.sh
+++ b/scripts/build_emscripten.sh
@@ -29,6 +29,7 @@
set -e
if [[ "$OSTYPE" != "darwin"* ]]; then
+ date -u +"nightly.%Y.%m.%d" > prerelease.txt
./scripts/travis-emscripten/install_deps.sh
docker run -v $(pwd):/src trzeci/emscripten:sdk-tag-1.35.4-64bit ./scripts/travis-emscripten/build_emscripten.sh
fi
diff --git a/scripts/release_ppa.sh b/scripts/release_ppa.sh
index 2fd286fd..8e9dc282 100755
--- a/scripts/release_ppa.sh
+++ b/scripts/release_ppa.sh
@@ -56,13 +56,13 @@ commithash=`git rev-parse --short HEAD`
committimestamp=`git show --format=%ci HEAD | head -n 1`
commitdate=`git show --format=%ci HEAD | head -n 1 | cut - -b1-10`
-# TODO store the commit hash in a file so that the build info mechanism can pick it up even without git
-
+echo "$commithash" > commit_hash.txt
if [ $branch = develop ]
then
debversion="$version-nightly-$commitdate-$commithash"
else
debversion="$version"
+ echo -n > prerelease.txt # proper release
fi
# gzip will create different tars all the time and we are not allowed
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-28 00:43:11 +0800