Skip to content

[docs] Add breeze command option for WSL2 #33549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 2 commits into from
Aug 20, 2023
Merged

[docs] Add breeze command option for WSL2 #33549

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74f43bc
[docs] Add breeze command option for WSL2
mingdaoy Aug 20, 2023
8fed2f6
Remove trailing whitespace
mingdaoy Aug 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions BREEZE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,22 @@ as follows:

breeze --python 3.8 --backend mysql --mysql-version 8

.. note:: Note for Windows WSL2 users

You may find error messages:

.. code-block:: bash

Current context is now "..."
protocol not available
Error 1 returned

Try adding ``--builder=default`` to your command. For example:

.. code-block:: bash

breeze --builder=default --python 3.8 --backend mysql --mysql-version 8

The choices you make are persisted in the ``./.build/`` cache directory so that next time when you use the
``breeze`` script, it could use the values that were used previously. This way you do not have to specify
them when you run the script. You can delete the ``.build/`` directory in case you want to restore the
Expand Down