doc: Improve notes on installing WSL on windows 10 #22373

nourou4them commented at 10:04 PM on June 29, 2021: none

The update is about the adding of a section about installing WSL on non-system drive like D:\ or F:. While installing the wsl as advised in the build-windows.md doc, we could not be able to build bitcoin due to a lack of space in the C:\ drive. That would also make impossible to run tests (units, regression and functional).

DrahtBot added the label Docs on Jun 29, 2021

fanquake added the label Windows on Jun 30, 2021

fanquake commented at 1:53 AM on June 30, 2021: member

Thanks, this is better than adding another file.

The linter is failing because This diff appears to have added new lines with trailing whitespace..

While you're modifying this, can you also remove this sentence: Ubuntu Bionic 18.04 is required and is the platform used to build the Bitcoin Core Windows release binaries. from the line that starts with On Linux, using the near the top of the file. Any linux with a modern mingw-w64 should work, and the release binaries (gitian) are currently build on 20.04.

nourou4them commented at 8:03 AM on June 30, 2021: none

Yes that is better indeed. I have corrected the whitespaces. The sentence is also removed. I got the point. Thanks.

MarcoFalke commented at 8:08 AM on June 30, 2021: member

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

doc: Improve notes on installing WSL on windows 10

The update is about the adding of a section about installing WSL on non-system drive like D:\ or F:.
While installing the wsl as advised in the build-windows.md doc, we could not be able to build bitcoin due to a lack of space in the C:\ drive.
That would also make impossible to run tests (units, regression and functional).
It was also asked to delete whitespaces and following sentence : "Ubuntu Bionic 18.04 is required and is the platform used to build the Bitcoin Core Windows release binaries.".

4bb9c7334e

nourou4them force-pushed on Jun 30, 2021

nourou4them commented at 3:08 PM on June 30, 2021: none

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

Just done !

in doc/build-windows.md:48 in 4bb9c7334e outdated

  43 | @@ -44,6 +44,32 @@ To install WSL on Windows 10 with Fall Creators Update installed (version >= 162
  44 |    * Open a cmd prompt and type "Ubuntu1804"
  45 |    * Create a new UNIX user account (this is a separate account from your Windows account)
  46 |  
  47 | +### Install on non-system drive (D:\ , F:\ ...)
  48 | +1. Enable windows subsystem for Linux system feature

RiccardoMasutti commented at 5:53 PM on July 21, 2021:

1. Enable Windows Subsystem for Linux system feature

in doc/build-windows.md:58 in 4bb9c7334e outdated

  53 | +
  54 | +2. Create an Ubuntu folder
  55 | +
  56 | +       mkdir D:\WSL\Ubuntu
  57 | +
  58 | +3. Download and install a Linux distribution (example : Ubuntu 18.04)

RiccardoMasutti commented at 5:53 PM on July 21, 2021:

3. Download and install a Linux distribution (eg.Ubuntu 18.04)

nourou4them commented at 9:59 AM on August 26, 2021:

Thanks for the review !

RiccardoMasutti changes_requested

Update doc/build-windows.md

Co-authored-by: Riccardo Masutti <46527252+RiccardoMasutti@users.noreply.github.com>

aabdf2717f

in doc/build-windows.md:47 in 4bb9c7334e outdated

  43 | @@ -44,6 +44,32 @@ To install WSL on Windows 10 with Fall Creators Update installed (version >= 162
  44 |    * Open a cmd prompt and type "Ubuntu1804"
  45 |    * Create a new UNIX user account (this is a separate account from your Windows account)
  46 |  
  47 | +### Install on non-system drive (D:\ , F:\ ...)

unknown commented at 10:50 AM on August 26, 2021:

Sorry but I don't think this section is required in Bitcoin Core docs. This can be helpful either in some Microsoft support page or Stackexchange/Stackoverflow Q&A.

nourou4them commented at 10:59 AM on August 26, 2021:

Knowing that this documentation is called build-windows, I thought it was ok to add another option for windows users to build core as I had to make some researchs myself because the first option wasn't working for me. But I totally respect your opinion if you think this part should belong to somewhere else.

hebasto commented at 3:24 PM on September 3, 2021:

Sorry but I don't think this section is required in Bitcoin Core docs. This can be helpful either in some Microsoft support page or Stackexchange/Stackoverflow Q&A.

I do agree with @prayank23 because the added instructions are not Bitcoin Core specific.

laanwj commented at 6:24 PM on September 16, 2021:

I'm also not very keen on adding a lot of general instructions here, it could easily go out of date if Microsoft changes something upstream. I wonder if we should have WSL install instructions at all, isn't there some document on the official Microsoft site we can link to instead?

fanquake commented at 3:30 AM on September 17, 2021: member

I've opened #23007 to just remove this installation section. I agree that pointing to upstream is better, than replicating install instructions here.

DrahtBot commented at 12:04 PM on September 18, 2021: member

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

Conflicts

Reviewers, this pull request conflicts with the following ones:

#23007 (doc: remove WSL install instructions and point to upstream by fanquake)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

shaavan commented at 1:00 PM on September 18, 2021: contributor

Concept 0

I can see the motivation behind suggesting to add these changes. But I prefer its alternative #23007 over this PR because:

Adding more doc files that are susceptible to becoming outdated increases the maintenance burden over the system.
Pointing upstream does the same job. But it is better because: a. Removes maintenance burden. b. Makes sure that the instructions are always up to date with the latest update.

nourou4them commented at 8:50 AM on September 19, 2021: none

Thank you all guys for your feedbacks. I understand the need to keep it as simple as possible, and to rely on the official documentation.

Should I close this PR now ?

fanquake commented at 3:07 AM on September 20, 2021: member

Should I close this PR now ?

Yes we can close this PR.

fanquake closed this on Sep 20, 2021

DrahtBot locked this on Oct 30, 2022