From 26ccb982228c79360c204dac3aa7a95caf943cfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20=C5=9Aliwak?= Date: Thu, 6 Aug 2020 14:39:34 +0200 Subject: [PATCH] docs: Update old external links to use HTTPS where possible --- docs/brand-guide.rst | 2 +- docs/contributing.rst | 4 ++-- docs/index.rst | 4 ++-- docs/installing-solidity.rst | 4 ++-- docs/introduction-to-smart-contracts.rst | 2 +- docs/resources.rst | 2 +- docs/style-guide.rst | 2 +- docs/units-and-global-variables.rst | 2 +- scripts/install_deps.sh | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/brand-guide.rst b/docs/brand-guide.rst index 0e6400bed..dda438533 100644 --- a/docs/brand-guide.rst +++ b/docs/brand-guide.rst @@ -43,7 +43,7 @@ Solidity Logo License :alt: Creative Commons License The Solidity logo is distributed and licensed under a `Creative Commons -Attribution 4.0 International License `_. +Attribution 4.0 International License `_. This is the most permissive Creative Commons license and allows reuse and modifications for any purpose. diff --git a/docs/contributing.rst b/docs/contributing.rst index 5d7dc9591..a5932c8fe 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -254,7 +254,7 @@ inside the input. We have a specialized binary called ``solfuzzer`` which takes and fails whenever it encounters an internal compiler error, segmentation fault or similar, but does not fail if e.g., the code contains an error. This way, fuzzing tools can find internal problems in the compiler. -We mainly use `AFL `_ for fuzzing. You need to download and +We mainly use `AFL `_ for fuzzing. You need to download and install the AFL packages from your repositories (afl, afl-clang) or build them manually. Next, build Solidity (or just the ``solfuzzer`` binary) with AFL as your compiler: @@ -388,7 +388,7 @@ local slang and references, making your language as clear to all readers as poss Title Case for Headings ----------------------- -Use `title case `_ for headings. This means capitalise all principal words in +Use `title case `_ for headings. This means capitalise all principal words in titles, but not articles, conjunctions, and prepositions unless they start the title. diff --git a/docs/index.rst b/docs/index.rst index 470fc56fe..2468c4867 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -72,10 +72,10 @@ Community volunteers help translate this documentation into several languages. They have varying degrees of completeness and up-to-dateness. The English version stands as a reference. -* `French `_ (in progress) +* `French `_ (in progress) * `Italian `_ (in progress) * `Japanese `_ -* `Korean `_ (in progress) +* `Korean `_ (in progress) * `Russian `_ (rather outdated) * `Simplified Chinese `_ (in progress) * `Spanish `_ diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index 38739e2ff..7a5c52d71 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -205,7 +205,7 @@ The following are dependencies for all builds of Solidity: | `cvc4`_ (Optional) | For use with SMT checker. | +-----------------------------------+-------------------------------------------------------+ -.. _cvc4: http://cvc4.cs.stanford.edu/web/ +.. _cvc4: https://cvc4.cs.stanford.edu/web/ .. _Git: https://git-scm.com/download .. _Boost: https://www.boost.org .. _CMake: https://cmake.org/download/ @@ -243,7 +243,7 @@ command-line builds: sudo xcodebuild -license accept -Our OS X build script uses `the Homebrew `_ +Our OS X build script uses `the Homebrew `_ package manager for installing external dependencies. Here's how to `uninstall Homebrew `_, diff --git a/docs/introduction-to-smart-contracts.rst b/docs/introduction-to-smart-contracts.rst index 39454ece1..f2b12e930 100644 --- a/docs/introduction-to-smart-contracts.rst +++ b/docs/introduction-to-smart-contracts.rst @@ -285,7 +285,7 @@ likely it will be. since it is not up to the submitter of a transaction, but up to the miners to determine in which block the transaction is included. If you want to schedule future calls of your contract, you can use - the `alarm clock `_ or a similar oracle service. + the `alarm clock `_ or a similar oracle service. .. _the-ethereum-virtual-machine: diff --git a/docs/resources.rst b/docs/resources.rst index 157f7d066..a4eecd34e 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -80,7 +80,7 @@ Solidity Integrations * Visual Studio Code: - * `Visual Studio Code extension `_ + * `Visual Studio Code extension `_ Solidity plugin for Microsoft Visual Studio Code that includes syntax highlighting and the Solidity compiler. Discontinued: diff --git a/docs/style-guide.rst b/docs/style-guide.rst index 3b52d7c47..73a65df08 100644 --- a/docs/style-guide.rst +++ b/docs/style-guide.rst @@ -1145,7 +1145,7 @@ NatSpec Solidity contracts can have a form of comments that are the basis of the Ethereum Natural Language Specification Format. -Add comments above functions or contracts following `doxygen `_ notation +Add comments above functions or contracts following `doxygen `_ notation of one or multiple lines starting with ``///`` or a multiline comment starting with ``/**`` and ending with ``*/``. diff --git a/docs/units-and-global-variables.rst b/docs/units-and-global-variables.rst index ab5d35baf..b67f84739 100644 --- a/docs/units-and-global-variables.rst +++ b/docs/units-and-global-variables.rst @@ -201,7 +201,7 @@ Mathematical and Cryptographic Functions If you use ``ecrecover``, be aware that a valid signature can be turned into a different valid signature without requiring knowledge of the corresponding private key. In the Homestead hard fork, this issue was fixed - for _transaction_ signatures (see `EIP-2 `_), but + for _transaction_ signatures (see `EIP-2 `_), but the ecrecover function remained unchanged. This is usually not a problem unless you require signatures to be unique or diff --git a/scripts/install_deps.sh b/scripts/install_deps.sh index a825a6d84..87f889e8f 100755 --- a/scripts/install_deps.sh +++ b/scripts/install_deps.sh @@ -101,7 +101,7 @@ case $(uname -s) in esac # Check for Homebrew install and abort if it is not installed. - brew -v > /dev/null 2>&1 || { echo >&2 "ERROR - solidity requires a Homebrew install. See http://brew.sh."; exit 1; } + brew -v > /dev/null 2>&1 || { echo >&2 "ERROR - solidity requires a Homebrew install. See https://brew.sh."; exit 1; } brew update brew install boost brew install cmake