Trivial: Language Cleanup

wbarobinson commented at 8:31 pm on April 17, 2018: contributor

fanquake added the label Docs on Apr 17, 2018

fanquake commented at 6:14 am on April 18, 2018: member

Thanks for the contribution. Some of these changes seem like re-writing for the sake of re-writing/updating. In any case, please squash all your changes into a single commit with a descriptive commit message.

in doc/tor.md:108 in 128299f3b8 outdated

104@@ -105,10 +105,10 @@ and, if not disabled, configured using the `-torcontrol` and `-torpassword` sett
105 To show verbose debugging information, pass `-debug=tor`.
106 
107 Connecting to Tor's control socket API requires one of two authentication methods to be 
108-configured. For cookie authentication the user running bitcoind must have write access 
109-to the `CookieAuthFile` specified in Tor configuration. In some cases this is 
110+configured. For cookie authentication the user running bitcoind must have write access

practicalswift commented at 1:04 pm on April 18, 2018:

Seems to be some trailing whitespace here?

practicalswift commented at 1:05 pm on April 18, 2018: contributor

Concept ACK, but please squash into one commit and remove the trailing whitespace:

0This diff appears to have added new lines with trailing whitespace.
1The following changes were suspected:
2diff --git a/doc/tor.md b/doc/tor.md
3@@ -108,2 +108,2 @@ Connecting to Tor's control socket API requires one of two authentication method
4+configured. For cookie authentication the user running bitcoind must have write access
5+to the `CookieAuthFile` specified in Tor configuration. In some cases, this is
6@@ -111 +111 @@ preconfigured and the creation of a hidden service is automatic. If permission p
7+are seen with `-debug=tor` they can be resolved by adding both the user running Tor and
8^---- failure generated from contrib/devtools/lint-whitespace.sh

in doc/build-unix.md:10 in 128299f3b8 outdated

 6@@ -7,7 +7,7 @@ Some notes on how to build Bitcoin Core in Unix.
 7 
 8 Note
 9 ---------------------
10-Always use absolute paths to configure and compile bitcoin and the dependencies,
11+Always use absolute paths to configure and compile bitcoin-core and the dependencies,

MarcoFalke commented at 1:08 pm on April 18, 2018:

Should say “Bitcoin Core”

wbarobinson commented at 1:43 pm on April 18, 2018:

Good catch.

in doc/build-unix.md:132 in 128299f3b8 outdated

128@@ -129,7 +129,7 @@ libqrencode (optional) can be installed with:
129 
130     sudo apt-get install libqrencode-dev
131 
132-Once these are installed, they will be found by configure and a bitcoin-qt executable will be
133+Once these are installed, they will be found by configure and a Bitcoin-Qt executable will be

MarcoFalke commented at 1:08 pm on April 18, 2018:

the executable name was correct before

wbarobinson commented at 1:46 pm on April 18, 2018:

The documentation uses many different variants. Is it entirely system dependent? In build-unix.md, for instance, it shows up in upper and lower case.

MarcoFalke commented at 1:48 pm on April 18, 2018:

It could be upper case on macOS, but I don’t see a reason to change it here

in doc/build-unix.md:232 in 128299f3b8 outdated

227@@ -228,24 +228,24 @@ Hardening enables the following features:
228     ET_DYN
229 
230 * Non-executable Stack
231-    If the stack is executable then trivial stack based buffer overflow exploits are possible if
232-    vulnerable buffers are found. By default, bitcoin should be built with a non-executable stack
233+    If the stack is executable then trivial stack-based buffer overflow exploits are possible if
234+    vulnerable buffers are found. By default, Bitcoin should be built with a non-executable stack,

MarcoFalke commented at 1:09 pm on April 18, 2018:

Either lower case or “Bitcoin Core”

practicalswift commented at 2:18 pm on April 18, 2018: contributor

Nice first-time documentation contribution. Thanks! Please squash into one commit.

Trivial: Fixed Typos and Cleaned Up 791075c609

wbarobinson force-pushed on Apr 19, 2018

wbarobinson commented at 2:13 pm on April 19, 2018: contributor

Thank you for your feedback, you have been super helpful. I have squashed the commits.

practicalswift commented at 2:20 pm on April 19, 2018: contributor

ACK 791075c609a759f70b2536ce6d9a8e404ba70404

in doc/README.md:6 in 791075c609 outdated

2@@ -3,7 +3,7 @@ Bitcoin Core
3 
4 Setup
5 ---------------------
6-Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions (which is currently more than 100 GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
7+Bitcoin Core, the original Bitcoin client, builds the network's backbone. It downloads and, by default, stores the entire history of Bitcoin transactions (which is currently more than 160 GB). Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to over a day.

Empact commented at 9:46 pm on April 23, 2018:

nit: I prefer the original first sentence. It flows a bit better.

wbarobinson commented at 12:50 pm on April 27, 2018:

I disagree, but perhaps we could come up with a compromise, such as: Bitcoin Core is the original and current reference implementation of the Bitcoin network.

in doc/developer-notes.md:498 in 791075c609 outdated

500+- Use `std::string`, avoid C string manipulation functions.
501 
502   - *Rationale*: C++ string handling is marginally safer, less scope for
503-    buffer overflows and surprises with `\0` characters. Also some C string manipulations
504-    tend to act differently depending on platform, or even the user locale
505+    buffer overflows and fewer surprises with `\0` characters. Also some C string manipulations

jnewbery commented at 9:55 pm on April 23, 2018:

First sentence still sounds odd to me. How about:

0C++ string handling is marginally safer, has less scope for buffer overflows and there are fewer surprises with `\0` characters.

?

wbarobinson commented at 12:52 pm on April 27, 2018:

Is this okay?

C++ string handling is marginally safer, with less scope for buffer overflows and fewer surprises with \0 characters.

in doc/developer-notes.md:803 in 791075c609 outdated

801 - Use the JSON parser for parsing, don't manually parse integers or strings from
802   arguments unless absolutely necessary.
803 
804   - *Rationale*: Introduces hand-rolled string manipulation code at both the caller and callee sites,
805-    which is error prone, and it is easy to get things such as escaping wrong.
806+    which is error prone, and it is easy to get things, such as escaping, wrong.

jnewbery commented at 9:56 pm on April 23, 2018:

I prefer without the extra commas here.

wbarobinson commented at 1:02 pm on April 27, 2018:

how about?: which is error prone and hard to use. For instance, it is easy to incorrectly escape.

jnewbery commented at 9:57 pm on April 23, 2018: member

seem like mostly good changes.

Standardizing Spelling b7854431ca

Standardized Spelling eb9f98740f

Standardized Spelling 4dc422dfa7

Standardized Spelling 849794eb7f

Spelling Standarization b59df17f01

Standardized Spelling 483ed66637

Standardized Spelling 6acff0127e

fanquake commented at 3:39 am on May 17, 2018: member

Rebased in #13255.

fanquake closed this on May 17, 2018

MarcoFalke referenced this in commit 1ef57a96b8 on Aug 2, 2018

UdjinM6 referenced this in commit eac7a01094 on Jun 29, 2021

UdjinM6 referenced this in commit e6c9bbd743 on Jun 29, 2021

UdjinM6 referenced this in commit d64541b7ef on Jul 1, 2021

UdjinM6 referenced this in commit 3e9bf2a8c8 on Jul 2, 2021

UdjinM6 referenced this in commit 8e3565df8e on Jul 2, 2021

DrahtBot locked this on Sep 8, 2021

Trivial: Language Cleanup #13010