summaryrefslogtreecommitdiff
path: root/BaseTools/Source/Python
diff options
context:
space:
mode:
authorOliver Smith-Denny <osde@linux.microsoft.com>2024-09-04 10:02:09 -0700
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2024-09-10 00:41:53 +0000
commit61f9695f20a575085d0579a0d3efc41b322ce1ac (patch)
treedc2786b3cec050cf070e08f364575d2b1cb3130e /BaseTools/Source/Python
parent3885a3edad618861168fe7081027867f1753ed42 (diff)
downloadedk2-61f9695f20a575085d0579a0d3efc41b322ce1ac.zip
edk2-61f9695f20a575085d0579a0d3efc41b322ce1ac.tar.gz
edk2-61f9695f20a575085d0579a0d3efc41b322ce1ac.tar.bz2
BaseTools: Remove Pip BaseTools
BaseTools was moved out to a separate repo and consumed as a pip module by edk2 CI. This process has not led to the desired goals of doing so, so this patch removes the pip based BaseTools from edk2 CI. The original goal of moving BaseTools to a pip module was primarily to speed up the development process, as the old edk2 mailing list was slow. However, with edk2 moving to PRs, it now actually slows the BaseTools development process to have to do a PR in another repo, publish the module, and then make a PR in edk2 to consume the new BaseTools. It also holds up using the features in a new BaseTools in other PRs. There were other goals of moving, such as allowing projects to use the BaseTools outside of edk2. This can still be accomplished outside of this PR, this PR simply stops edk2 CI from using the pip module. Continuous-integration-options: PatchCheck.ignore-multi-package Signed-off-by: Oliver Smith-Denny <osde@linux.microsoft.com>
Diffstat (limited to 'BaseTools/Source/Python')
-rw-r--r--BaseTools/Source/Python/README.md29
1 files changed, 0 insertions, 29 deletions
diff --git a/BaseTools/Source/Python/README.md b/BaseTools/Source/Python/README.md
deleted file mode 100644
index 8c4d9e7..0000000
--- a/BaseTools/Source/Python/README.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# Edk2 Basetools
-
-This folder has traditionally held the source of Python based tools used by EDK2.
-The official repo this source has moved to https://github.com/tianocore/edk2-basetools.
-This folder will remain in the tree until the next stable release (expected 202102).
-There is a new folder under Basetools `BinPipWrappers` that uses the pip module rather than this tree for Basetools.
-By adding the scope `pipbuild-win` or `pipbuild-unix` (depending on your host system), the SDE will use the
-`BinPipWrappers` instead of the regular `BinWrappers`.
-
-## Why Move It?
-
-The discussion is on the mailing list. The RFC is here: https://edk2.groups.io/g/rfc/topic/74009714#270
-The benefits allow for the Basetools project to be used separately from EDK2 itself as well as offering it in a
-globally accessible manner.
-This makes it much easier to build a module using Basetools.
-Separating the Basetools into their own repo allows for easier CI and contribution process.
-Additional pros, cons, and process can be found on the mailing list.
-
-## How Do I Install It?
-
-By default, EDK2 is tied to and tested with a specific version of the Basetools through `pip-requirements.txt`.
-You can simply run:
-
-```bash
-pip install -r pip-requirements.txt
-```
-
-This will install the required module, thought we strongly suggest setting up a virtual environment.
-Additionally, you can also install a local clone of the Basetools as well as a specific git commit.