doc: update IBD requirements in doc/README.md

Mackain commented at 9:15 pm on September 27, 2024: contributor

A small change to the first paragraph of the Setup part of the README that has been bugging me for a while. The disk space required for the Bitcoin transactions can no longer be described as “a few” hundred gigabytes. So I thought it was time it was changed to “several” instead.

DrahtBot commented at 9:15 pm on September 27, 2024: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	danielabrozzoni, jonatack, ismaelsadeeq, tdb3, itornaza, achow101

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

DrahtBot added the label Docs on Sep 27, 2024

in doc/README.md:6 in a5cb8b378c 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 requires a few hundred gigabytes of disk space. 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 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 requires several hundred gigabytes of disk space. 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.

jonatack commented at 10:02 pm on September 27, 2024:

This change looks like a continuation of #14511.

Perhaps go a bit further, if we continue to prefer to give an idea of disk space and sync time here.

0Bitcoin 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 requires several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days or more.

Mackain commented at 10:07 pm on September 27, 2024:

@jonatack good point! thanks for the suggestion

DrahtBot added the label CI failed on Sep 29, 2024

DrahtBot removed the label CI failed on Sep 29, 2024

IsaacCavallaro approved

Mackain requested review from jonatack on Sep 30, 2024

jonatack commented at 9:52 pm on September 30, 2024: member

ACK 3208df2a100f58569165081cd20c02abed827286

Might be good to update the PR description to reflect the changes (and the commit message as well, if you need to repush).

Suggestion for the PR title: doc: update IBD requirements in doc/README.md

Mackain renamed this:
~~doc: Minor update to doc/README.md~~
doc: update IBD requirements in doc/README.md
on Oct 1, 2024

Mackain force-pushed on Oct 1, 2024

Mackain commented at 7:04 am on October 1, 2024: contributor

ACK 3208df2

Might be good to update the PR description to reflect the changes (and the commit message as well, if you need to repush).

Suggestion for the PR title: doc: update IBD requirements in doc/README.md @jonatack thanks! Updated the PR title as you suggested. The commit message was created automatically when I clicked the “Commit Suggestion” button on your previous feedback. Fixing it now.

maflcko commented at 7:21 am on October 1, 2024: member

Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits

Mackain force-pushed on Oct 1, 2024

Mackain commented at 7:36 am on October 1, 2024: contributor

Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits @maflcko thanks for pointing that out, fixing now

Mackain force-pushed on Oct 1, 2024

jonatack commented at 1:43 pm on October 2, 2024: member

The commit message was created automatically when I clicked the “Commit Suggestion” button on your previous feedback. Fixing it now. @Mackain The commit message wasn’t updated yet, could you update it and re-push the same commit (thanks!)

Edit: if helpful, reckon you could use the same commit message as the PR title.

Mackain closed this on Oct 2, 2024

Mackain reopened this on Oct 2, 2024

Mackain commented at 3:45 pm on October 2, 2024: contributor

The commit message was created automatically when I clicked the “Commit Suggestion” button on your previous feedback. Fixing it now.

@Mackain The commit message wasn’t updated yet, could you update it and re-push the same commit (thanks!)

Edit: if helpful, reckon you could use the same commit message as the PR title.

Ah, sorry. I now understand what you mean. I originally thought you wanted me to update the commit message of 3208df2, I did that, but then soon after squashed the two commits as per maflcko’s comment. I apologize for the confusion and will now update the remaining commit message. Thank you for your patience.

doc: update IBD requirements in doc/README.md 36a6d4b007

Mackain force-pushed on Oct 2, 2024

danielabrozzoni approved

danielabrozzoni commented at 4:56 pm on October 2, 2024: contributor

ACK 36a6d4b0078ebb39ed082c866bf49214a2a01241

DrahtBot requested review from jonatack on Oct 2, 2024

jonatack commented at 5:05 pm on October 2, 2024: member

ACK 36a6d4b0078ebb39ed082c866bf49214a2a01241

in doc/README.md:6 in 36a6d4b007

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 requires a few hundred gigabytes of disk space. 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 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 requires several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days or more.

ismaelsadeeq commented at 11:07 am on October 3, 2024:

nit: maybe just say hundreds

0Bitcoin 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 requires hundreds of gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days or more.

jonatack commented at 2:39 pm on October 3, 2024:

I think I prefer “several hundred or more”, as given the current size required, it conveys the floor to expect a bit more, and when the requirement breaks past a terabyte, “or more” allows more time before updating again, whereas “hundreds” might be construed as or implies “not thousands.”

ismaelsadeeq commented at 3:28 pm on October 3, 2024:

whereas “hundreds” might be construed as or implies “not thousands.”

I just wanted to be specific on the what is the requirement currently. “several hundred or more” is not specific.

it conveys the floor to expect a bit more, and when the requirement breaks past a terabyte, “or more” allows more time before updating again.

Fair enough, it is likely to break hundreds, so this comment can be ignored; it’s a non-blocking nit.

ismaelsadeeq commented at 11:08 am on October 3, 2024: member

ACK 36a6d4b0078ebb39ed082c866bf49214a2a01241

tdb3 approved

tdb3 commented at 2:07 pm on October 4, 2024: contributor

ACK 36a6d4b0078ebb39ed082c866bf49214a2a01241

Thanks. It’s good to keep user-facing docs current, to manage user expectations.

itornaza approved

itornaza commented at 6:19 pm on October 9, 2024: contributor

ACK 36a6d4b0078ebb39ed082c866bf49214a2a01241

achow101 commented at 0:00 am on October 10, 2024: member

ACK 36a6d4b0078ebb39ed082c866bf49214a2a01241

achow101 merged this on Oct 10, 2024

achow101 closed this on Oct 10, 2024

doc: update IBD requirements in doc/README.md #30992

Code Coverage

Reviews