[DOCS] Add BSD build instructions #5955
Conversation
docs/installing-solidity.rst
Outdated
| +-----------------------------------+-------------------------------------------------------+ | ||
| | `Boost`_ | C++ libraries. | | ||
| +-----------------------------------+-------------------------------------------------------+ | ||
| | `z3`_ | Theorem prover. | |
There was a problem hiding this comment.
@axic BSD doesn't come with any of these packages, and you need them to build Solidity, so that's a requirement isn't it?
There was a problem hiding this comment.
It's an optional dependency.
There was a problem hiding this comment.
z3 is optional on all platforms. It is not listed on the others, shouldn't list it for BSD. Unless the install_deps script is broken and requires it, of course.
There was a problem hiding this comment.
@axic Ah ha, OK, that was just taken from the original poster. And what do you think about adding the "untested" disclaimer?
Codecov Report
@@ Coverage Diff @@
## develop #5955 +/- ##
========================================
Coverage 88.32% 88.32%
========================================
Files 361 361
Lines 34788 34788
Branches 4121 4121
========================================
Hits 30727 30727
Misses 2684 2684
Partials 1377 1377
|
ChrisChinchilla
force-pushed
the
docs-openbsd
branch
from
4dcd494 to
e2c9bb3
Compare
docs/installing-solidity.rst
Outdated
| @@ -228,6 +228,28 @@ in Visual Studio 2017 Build Tools or Visual Studio 2017: | |||
| .. _Visual Studio 2017: https://www.visualstudio.com/vs/ | |||
| .. _Visual Studio 2017 Build Tools: https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017 | |||
|
|
|||
| Prerequisites - OpenBSD | |||
There was a problem hiding this comment.
The instructions here are extremely generic and do not look OpenBSD-specific. Perhaps rename this to "other" or something like that? :)
There was a problem hiding this comment.
Yeah, I agree @chriseth Our dependency scripts don't work on OpenBSD, so you do need these. I guess BSD is the most likely "other OS", but how about we use the language from above, something like "Other Unix-style OSs (e.g. BSD)", something like that? Just so the BSD part is searchable.
There was a problem hiding this comment.
I'm actually not sure we should encourage the use of the dependency script. Installing packages should not be taken lightly. Perhaps we should start the section about which dependencies are required and which are recommended in general and then go into detail about how exactly you do it on the specific systems.
There was a problem hiding this comment.
@chriseth Sounds like a good idea, but do you think it gets out of the scope of this PR?
There was a problem hiding this comment.
Yes, sounds like in scope for me, unless we have more detailed instructions for bsd
|
try this @chriseth the PR really becomes less about BSD, but I think the changes tidy things up a bit. I tried to make using the dependency script a little less like a step you have to take, and more of a step you can take. |
ChrisChinchilla
force-pushed
the
docs-openbsd
branch
from
0767867 to
eff0daa
Compare
docs/installing-solidity.rst
Outdated
| +-----------------------------------+-------------------------------------------------------+ | ||
| | `Git`_ | Command-line tool for retrieving source code. | | ||
| +-----------------------------------+-------------------------------------------------------+ | ||
| | `z3`_ (Optional) | For use with SMT checker. | |
There was a problem hiding this comment.
Should also add cvc4 (Optional) - For use with SMT checker - http://cvc4.cs.stanford.edu/web/
docs/installing-solidity.rst
Outdated
| +-----------------------------------+-------------------------------------------------------+ | ||
| | `Git`_ | Command-line tool for retrieving source code. | | ||
| +-----------------------------------+-------------------------------------------------------+ | ||
| | `z3`_ (Optional) | For use with SMT checker. | |
There was a problem hiding this comment.
z3: version 4.6.0 or newer
|
Added extra details as mentioned @chriseth |
Add BSD instructions Remove z3 dependency from OpenBSD Add disclaimer Generalise build instructions Update docs/installing-solidity.rst Co-Authored-By: ChrisChinchilla <[email protected]> Add extra version details
ChrisChinchilla
force-pushed
the
docs-openbsd
branch
from
9e37443 to
ef9854d
Compare
|
@chriseth Done. |
|
Nice! |
Description
Closes #5728 by adding BSD build instructions as mentioned by @flipchan I haven't been able to successfully test these running in an emulator on my Mac, but the original poster said they work. So either we test them elsewhere or add a disclaimer saying that they are untested?
Checklist