Merge #14583: docs: Textual improvements in build docs

36c8e68585 Various textual improvements in build docs (Martin Erlandsson)

Pull request description:

  While reading the build docs, I found some opportunities for textual improvements (Force of habit, I used to work as a technical writer...)

  * Added a few missing words, should be uncontroversial.

  * Changed/added some punctuation, for better flow and readability.

  * Fixed one Markdown issue, where two list item headings rendered without a line break. (See image)
  This one needs to be verified after a build, I don't have a proper build environment yet.

  <img width="403" alt="layout_issue" src="https://user-images.githubusercontent.com/453092/47555613-893b4d00-d90c-11e8-8a31-943846059ae7.png">

Tree-SHA512: 1e40a0414e2ce91d223933cca169d3cef25f9d2c606fd75476cef946095eee161f700f9dbf8afe60388ab8c400283d057537266d171ea63125257b7156838ecb
This commit is contained in:
MarcoFalke 2018-10-28 06:41:40 -04:00 committed by Pasta
parent 53744e79f0
commit abeafe4488
No known key found for this signature in database
GPG Key ID: 52527BEDABE87984
2 changed files with 5 additions and 8 deletions

View File

@ -20,7 +20,7 @@ Base build dependencies
brew install automake libtool pkg-config brew install automake libtool pkg-config
``` ```
If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG:
```bash ```bash
brew install librsvg brew install librsvg
``` ```
@ -51,13 +51,13 @@ Running
Dash Core is now available at `./src/dashd` Dash Core is now available at `./src/dashd`
Before running, you may create an empty configuration file. Before running, you may create an empty configuration file:
touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf" touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
chmod 600 "/Users/${USER}/Library/Application Support/DashCore/dash.conf" chmod 600 "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
The first time you run dashd, it will start downloading the blockchain. This process could take several hours. The first time you run dashd, it will start downloading the blockchain. This process could take many hours, or even days on slower than average systems.
You can monitor the download process by looking at the debug.log file: You can monitor the download process by looking at the debug.log file:

View File

@ -57,9 +57,7 @@ Hardening Flags:
Hardening enables the following features: Hardening enables the following features:
* _Position Independent Executable_: Build position independent code to take advantage of Address Space Layout Randomization
* Position Independent Executable
Build position independent code to take advantage of Address Space Layout Randomization
offered by some kernels. Attackers who can cause execution of code at an arbitrary memory offered by some kernels. Attackers who can cause execution of code at an arbitrary memory
location are thwarted if they don't know where anything useful is located. location are thwarted if they don't know where anything useful is located.
The stack and heap are randomly located by default, but this allows the code section to be The stack and heap are randomly located by default, but this allows the code section to be
@ -77,8 +75,7 @@ Hardening enables the following features:
TYPE TYPE
ET_DYN ET_DYN
* Non-executable Stack * _Non-executable Stack_: If the stack is executable then trivial stack-based buffer overflow exploits are possible if
If the stack is executable then trivial stack-based buffer overflow exploits are possible if
vulnerable buffers are found. By default, Dash Core should be built with a non-executable stack, vulnerable buffers are found. By default, Dash Core should be built with a non-executable stack,
but if one of the libraries it uses asks for an executable stack or someone makes a mistake but if one of the libraries it uses asks for an executable stack or someone makes a mistake
and uses a compiler extension which requires an executable stack, it will silently build an and uses a compiler extension which requires an executable stack, it will silently build an