CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2026-04-22 02:59:17 -04:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Cleanup "About Virtual Environment" docs (#6701)

Browse Source
This commit is contained in:
EternalllZM
2026-03-29 10:54:58 -07:00
committed by GitHub
parent b83b882921
commit e2acec0862
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/about_venv.rst
View File

@@ -3,16 +3,14 @@
==========================
About Virtual Environments
==========================
Creating a virtual environment is really easy and usually prevents many common installation
problems.
Creating a virtual environment is simple and helps prevent installation problems.
**What Are Virtual Environments For?**
Virtual environments allow you to isolate Red's library dependencies, cog dependencies and python
binaries from the rest of your system. There is no performance overhead to using virtual environment
and it saves you from a lot of troubles during setup. It also makes sure Red and its dependencies
are installed to a predictable location which makes uninstalling Red as simple as removing a single folder,
without worrying about losing your data or other things on your system becoming broken.
Virtual environments allow you to isolate Red's library dependencies, cog dependencies, and Python
binaries from the rest of your system with no performance overhead, ensuring those dependencies
and Red are installed to a predictable location. This makes uninstalling Red as simple as removing
a single folder, preventing any data loss or breaking other things on your system.
--------------------------------------------
@@ -21,19 +19,21 @@ Virtual Environments with Multiple Instances
If you are running multiple instances of Red on the same machine, you have the option of either
using the same virtual environment for all of them, or creating separate ones.
.. note::
Using a *single* virtual environment for all of your instances means you:
This only applies for multiple instances of V3. If you are running a V2 instance as well,
you **must** use separate virtual environments.
- Only need to update Red once for all instances.
- Must shut down all instances prior to updating.
- Will save space on your hard drive.
- Want all instances to share the same version/dependencies.
The advantages of using a *single* virtual environment for all of your V3 instances are:
Using *multiple* virtual environments for each individual or select groups of instances means you:
- When updating Red, you will only need to update it once for all instances (however you will still need to restart all instances for the changes to take effect)
- It will save space on your hard drive
On the other hand, you may wish to update each of your instances individually.
- Need to update Red within each virtual environment separately.
- Can update Red without needing to update all instances.
- Only need to shut down the instance(s) being updated.
- Want different Red/dependency versions on different instances.
.. important::
Windows users with multiple instances should create *separate* virtual environments, as
updating multiple running instances at once is likely to cause errors.
Regardless of which option you choose, do not update while any instances within that virtual
environment are running. This is especially true for Windows, as files are locked by the system while in use.