diff options
author | Brent Cook <bcook@openbsd.org> | 2017-09-04 16:14:54 -0500 |
---|---|---|
committer | Brent Cook <bcook@openbsd.org> | 2017-09-04 16:14:54 -0500 |
commit | b623db7bfb350a19ad2d9ef0231f6d329cf7ab99 (patch) | |
tree | f2cddede565d53cdc8ce8e5a3cd3e729bf449fbd | |
parent | 3612cbe3a0abfd4862eb8cc40c17da30352b2eb7 (diff) | |
download | portable-b623db7bfb350a19ad2d9ef0231f6d329cf7ab99.tar.gz portable-b623db7bfb350a19ad2d9ef0231f6d329cf7ab99.tar.bz2 portable-b623db7bfb350a19ad2d9ef0231f6d329cf7ab99.zip |
enhance README warnings, remove pod2man requirement
-rw-r--r-- | README.md | 23 |
1 files changed, 14 insertions, 9 deletions
@@ -56,20 +56,25 @@ or to the github | |||
56 | Severe vulnerabilities or bugs requiring coordination with OpenSSL can be | 56 | Severe vulnerabilities or bugs requiring coordination with OpenSSL can be |
57 | sent to the core team at libressl-security@openbsd.org. | 57 | sent to the core team at libressl-security@openbsd.org. |
58 | 58 | ||
59 | ## Prerequisites when building from git ## | 59 | # Building LibreSSL # |
60 | 60 | ||
61 | If you have checked this source using Git, follow these initial steps to | 61 | ## Prerequisites when building from a Git checkout ## |
62 | prepare the source tree for building: | 62 | |
63 | If you have checked this source using Git, or have downloaded a source tarball | ||
64 | from Github, follow these initial steps to prepare the source tree for | ||
65 | building. *Your build _will fail_ if you do not follow these instructions! If | ||
66 | you do not want to follow these instructions or cannot meet the prerequistes, | ||
67 | download a release tarball from https://ftp.openbsd.org/pub/OpenBSD/LibreSSL/ instead. Using official release tarballs is strongly advised if you are not a developer.* | ||
63 | 68 | ||
64 | 1. Ensure you have the following packages installed: | 69 | 1. Ensure you have the following packages installed: |
65 | automake, autoconf, git, libtool, perl, pod2man | 70 | automake, autoconf, git, libtool, perl |
66 | 2. Run './autogen.sh' to prepare the source tree for building or | 71 | 2. Run './autogen.sh' to prepare the source tree for building or |
67 | run './dist.sh' to prepare a tarball. | 72 | run './dist.sh' to prepare a tarball. |
68 | 73 | ||
69 | ## Building LibreSSL ## | 74 | ## Steps that apply to all builds ## |
70 | 75 | ||
71 | Once you have a source tree from Git or FTP, run these commands to build and | 76 | Once you have a source tree using git or by downloading from an OpenBSD mirror, |
72 | install the package on most systems: | 77 | run these commands to build and install the package on most systems: |
73 | 78 | ||
74 | ```sh | 79 | ```sh |
75 | ./configure # see ./configure --help for configuration options | 80 | ./configure # see ./configure --help for configuration options |
@@ -134,8 +139,8 @@ projects or build by itself. | |||
134 | 139 | ||
135 | #### Cmake - Additional Options #### | 140 | #### Cmake - Additional Options #### |
136 | 141 | ||
137 | | Option Name | Default | Description | 142 | | Option Name | Default | Description |
138 | | ------------ | -----: | ------ | 143 | | ------------ | -----: | ------ |
139 | | LIBRESSL_SKIP_INSTALL | OFF | allows skipping install() rules. Can be specified from command line using <br>```-DLIBRESSL_SKIP_INSTALL=ON``` | | 144 | | LIBRESSL_SKIP_INSTALL | OFF | allows skipping install() rules. Can be specified from command line using <br>```-DLIBRESSL_SKIP_INSTALL=ON``` | |
140 | | ENABLE_ASM | ON | builds assembly optimized rules. | | 145 | | ENABLE_ASM | ON | builds assembly optimized rules. | |
141 | | ENABLE_EXTRATESTS | OFF | Enable extra tests that may be unreliable on some platforms | | 146 | | ENABLE_EXTRATESTS | OFF | Enable extra tests that may be unreliable on some platforms | |