Skip to content

Commit f41eb7d

Browse files
author
Release Manager
committed
gh-35843: Add a WSL prerequisites section <!-- Please provide a concise, informative and self-explanatory title. --> <!-- Don't put issue numbers in the title. Put it in the Description below. --> <!-- For example, instead of "Fixes #12345", use "Add a new method to multiply two integers" --> ### 📚 Description <!-- Describe your changes here in detail. --> This PR adds a new section named **WSL prerequesites**, moving the WSL- Ubuntu-specific section to as subsection and adding the WSL error under it under its own subsection. <!-- Why is this change required? What problem does it solve? --> This change was made because originally the build error and solutions appeared only under the WSL-Ubuntu-specific section but in reality this impacts all flavours of WSL, not just Ubuntu. <!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". --> Fixes #35840 <!-- If your change requires a documentation PR, please link it appropriately. --> This is what the documentation looks like with this change: ![image](https://github.com/sagemath/sage/assets/9839187/0114b3c5-f7f5- 4bae-8ca0-de11581e1e5d) which can be checked here: https://deploy-preview-35843--sagemath- tobias.netlify.app/installation/source.html#wsl-prerequisites ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x ]`. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [x] ~I have created tests covering the changes.~ Not needed - [x] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> None URL: #35843 Reported by: Daniel-Khodabakhsh Reviewer(s): Dima Pasechnik
2 parents 90ece16 + 13a0d2f commit f41eb7d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/doc/en/installation/source.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,11 @@ Some additional optional packages are taken care of by:
257257

258258
.. literalinclude:: homebrew-optional.txt
259259

260+
WSL prerequisites
261+
^^^^^^^^^^^^^^^^^
260262

261263
Ubuntu on Windows Subsystem for Linux (WSL) prerequisite installation
262-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
264+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
263265

264266
Sage can be installed onto Linux running on Windows Subsystem for Linux (WSL). These instructions describe a fresh install of Ubuntu 20.10, but other distributions or installation methods should work too, though have not been tested.
265267

@@ -283,11 +285,17 @@ Sage can be installed onto Linux running on Windows Subsystem for Linux (WSL). T
283285
From this point on, follow the instructions in the :ref:`sec-installation-from-sources-linux-recommended-installation` section.
284286
It is strongly recommended to put the Sage source files in the Linux file system, for example, in the ``/home/username/sage`` directory, and not in the Windows file system (e.g. ``/mnt/c/...``).
285287

288+
WSL permission denied error when building `packaging` package.
289+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
290+
286291
You may encounter permission errors of the kind ``"[Errno 13] Permission denied: 'build/bdist.linux-x86_64/wheel/<package>.dist-info'"`` during ``make``.
287292
This usually comes from a permission conflict between the Windows and Linux file system.
288293
To fix it create a temporary build folder in the Linux file system using ``mkdir -p ~/tmp/sage`` and use it for building by ``eval SAGE_BUILD_DIR="~/tmp/sage" make``.
289294
Also see the `related Github issue <https://github.com/pypa/packaging-problems/issues/258>`_ for other workarounds.
290295

296+
WSL post-installation notes
297+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
298+
291299
When the installation is complete, you may be interested in :ref:`sec-launching-wsl-post-installation`.
292300

293301
.. _section_cygwinprereqs:

0 commit comments

Comments
 (0)