diff mbox series

[5/6] patchtest.README: update host mode section

Message ID 20250918212743.3960-5-twoerner@gmail.com
State New
Headers show
Series [1/6] patchtest.README: trivial fixes | expand

Commit Message

Trevor Woerner Sept. 18, 2025, 9:27 p.m. UTC
Update the "Host Mode" section to provide more detail and exact steps
assuming the user is using a previously- or just-installed patchtest
following the steps outlined in the "Installation" section above in the
same document.

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 scripts/patchtest.README | 39 +++++++++++++++++++++++++++------------
 1 file changed, 27 insertions(+), 12 deletions(-)
diff mbox series

Patch

diff --git a/scripts/patchtest.README b/scripts/patchtest.README
index b321d8e47c49..30f7538529ed 100644
--- a/scripts/patchtest.README
+++ b/scripts/patchtest.README
@@ -181,27 +181,42 @@  storage formats.
 
 ### Host Mode
 
-To run patchtest on the host, do the following:
+To run patchtest in "host" mode, do the following:
 
-1. In openembedded-core/poky, do `source oe-init-build-env`
-2. Generate patch files from the target repository by doing `git format-patch -N`,
-   where N is the number of patches starting at HEAD, or by using git-pw
-   or patchtest-get-series
-3. Run patchtest on a patch file by doing the following:
+1. Using openembedded-core or poky, do the following if re-using the
+   installation given in the installation procedure above:
 
-        patchtest --patch /path/to/patch/file
+    $ . yocto/openembedded-core/oe-init-build-env build yocto/bitbake
+
+   or
+
+    $ . yocto/poky/oe-init-build-env
+
+2. Activate the Python virtual environment that was created using the
+   steps from the installation procedure given above:
+
+    $ . patchtest.venv/bin/activate
+
+3. Obtain one or more patches (see section above)
+
+4. Run patchtest on a patch file by doing the following:
+
+        (patchtest.venv) $ patchtest --patch /path/to/patch/file
 
     or, if you have stored the patch files in a directory, do:
 
-        patchtest --directory /path/to/patch/directory
+        (patchtest.venv) $ patchtest --directory /path/to/patch/directory
 
-    For example, to test `master-gcc-Fix--fstack-protector-issue-on-aarch64.patch` against the oe-core test suite:
+    For example, to test
+    `master-gcc-Fix--fstack-protector-issue-on-aarch64.patch` against the
+    oe-core test suite:
         
-        patchtest --patch master-gcc-Fix--fstack-protector-issue-on-aarch64.patch
+        (patchtest.venv) $ patchtest --patch master-gcc-Fix--fstack-protector-issue-on-aarch64.patch
 
-    If you want to use a different test suite or target repository, you can use the --testdir and --repodir flags:
+    If you want to use a different test suite or target repository, you
+    can use the --testdir and --repodir flags:
     
-        patchtest --patch /path/to/patch/file --repodir /path/to/repo --testdir /path/to/test/dir
+        (patchtest.venv) $ patchtest --patch /path/to/patch/file --repodir /path/to/repo --testdir /path/to/test/dir
 
 ### Guest Mode