Skip to contentSkip to conversation

standalone wic repository

PATCH New Trevor Woerner 1 participant 10 messages Apr 3 RISC-V

lore
Share & tools
lore
#0 lore raw

cover standalone wic repository

This patchset is meant to be applied to the wic codebase immediately after wic is split out from the OpenEmbedded-Core codebase. Afterwards this project was turned into a hatch-based Python project commit by commit, demonstrating that the starting point for this code was an unmodifed wic from oe-core, and showing how it was transformed.

The starting point for this repository involved using git-filter-repo to move the wic source into its own repository without any modifications:

    $ git-filter-repo --force --path scripts/wic --path scripts/lib/wic/

Trevor Woerner (9):
re-organize for python src layout packaging move example *wks files
create python hatch project
add oe-core and bitbake helper packages bump version: 0.2.0 -> 0.3.0
cli.py: remove bitbake coupling plugins/source/bootimg_biosplusefi.py: add import os ksparser.py: search for *inc files
cli.py: fix main() for standalone mode

 .gitignore                                    |   1 +
 LICENSE                                       | 288 ++++++++++++++
 README.md                                     |  51 +++
 .../canned-wks => example-wks}/common.wks.inc |   0
 .../directdisk-bootloader-config.cfg          |   0
 .../directdisk-bootloader-config.wks          |   0
 .../directdisk-gpt.wks                        |   0
 .../directdisk-multi-rootfs.wks               |   0
 .../canned-wks => example-wks}/directdisk.wks |   0
 .../efi-bootdisk.wks.in                       |   0
 .../efi-uki-bootdisk.wks.in                   |   0
 .../canned-wks => example-wks}/mkefidisk.wks  |   0
 .../mkhybridiso.wks                           |   0
 .../qemuloongarch.wks                         |   0
 .../canned-wks => example-wks}/qemuriscv.wks  |   0
 .../qemux86-directdisk.wks                    |   0
 .../sdimage-bootpart.wks                      |   0
 .../systemd-bootdisk.wks                      |   0
 pyproject.toml                                |  38 ++
 src/bb/__init__.py                            |  14 +
 src/bb/utils.py                               |  23 ++
 src/oe/__init__.py                            |   1 +
 src/oe/bootfiles.py                           |  58 +++
 src/oe/path.py                                | 351 ++++++++++++++++++
 {scripts/lib => src}/wic/__init__.py          |   0
 scripts/wic => src/wic/cli.py                 |  14 +-
 {scripts/lib => src}/wic/engine.py            |   0
 {scripts/lib => src}/wic/filemap.py           |   0
 {scripts/lib => src}/wic/help.py              |   0
 {scripts/lib => src}/wic/ksparser.py          |  18 +-
 {scripts/lib => src}/wic/misc.py              |   0
 {scripts/lib => src}/wic/partition.py         |   0
 {scripts/lib => src}/wic/pluginbase.py        |   0
 .../lib => src}/wic/plugins/imager/direct.py  |   0
 .../wic/plugins/source/bootimg_biosplusefi.py |   1 +
 .../wic/plugins/source/bootimg_efi.py         |   0
 .../wic/plugins/source/bootimg_partition.py   |   0
 .../wic/plugins/source/bootimg_pcbios.py      |   0
 .../lib => src}/wic/plugins/source/empty.py   |   0
 .../wic/plugins/source/extra_partition.py     |   0
 .../wic/plugins/source/isoimage_isohybrid.py  |   0
 .../lib => src}/wic/plugins/source/rawcopy.py |   0
 .../lib => src}/wic/plugins/source/rootfs.py  |   0
 43 files changed, 847 insertions(+), 11 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 LICENSE
 create mode 100644 README.md
 rename {scripts/lib/wic/canned-wks => example-wks}/common.wks.inc (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/directdisk-bootloader-config.cfg (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/directdisk-bootloader-config.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/directdisk-gpt.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/directdisk-multi-rootfs.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/directdisk.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/efi-bootdisk.wks.in (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/efi-uki-bootdisk.wks.in (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/mkefidisk.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/mkhybridiso.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/qemuloongarch.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/qemuriscv.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/qemux86-directdisk.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/sdimage-bootpart.wks (100%)
 rename {scripts/lib/wic/canned-wks => example-wks}/systemd-bootdisk.wks (100%)
 create mode 100644 pyproject.toml
 create mode 100644 src/bb/__init__.py
 create mode 100644 src/bb/utils.py
 create mode 100644 src/oe/__init__.py
 create mode 100644 src/oe/bootfiles.py
 create mode 100644 src/oe/path.py
 rename {scripts/lib => src}/wic/__init__.py (100%)
 rename scripts/wic => src/wic/cli.py (99%)
 rename {scripts/lib => src}/wic/engine.py (100%)
 rename {scripts/lib => src}/wic/filemap.py (100%)
 rename {scripts/lib => src}/wic/help.py (100%)
 rename {scripts/lib => src}/wic/ksparser.py (95%)
 rename {scripts/lib => src}/wic/misc.py (100%)
 rename {scripts/lib => src}/wic/partition.py (100%)
 rename {scripts/lib => src}/wic/pluginbase.py (100%)
 rename {scripts/lib => src}/wic/plugins/imager/direct.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_biosplusefi.py (99%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_efi.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_partition.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_pcbios.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/empty.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/extra_partition.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/isoimage_isohybrid.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/rawcopy.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/rootfs.py (100%)
Signature · 1 line
2.51.0
#1 lore raw

PATCH 1/9 re-organize for python src layout packaging

The git-filter-repo tool was used to take OpenEmbedded's wic utility and import it (without any modification whatsoever) into its own source code repository while preserving the entire git history, removing any files and git history not related to wic. The specific command used to perform this conversion on a clean checkout of the OpenEmbedded repository was:

    $ git-filter-repo --force --path scripts/wic --path scripts/lib/wic/

The goal of this conversion process is to end up with an independent Python package for wic. This commit moves the wic components into the Python de facto standard packaging "src layout" order. All components are moved as they are; the main wic program is moved and renamed to src/wic/cli.py.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

---
 {scripts/lib => src}/wic/__init__.py                              | 0
 {scripts/lib => src}/wic/canned-wks/common.wks.inc                | 0
 .../lib => src}/wic/canned-wks/directdisk-bootloader-config.cfg   | 0
 .../lib => src}/wic/canned-wks/directdisk-bootloader-config.wks   | 0
 {scripts/lib => src}/wic/canned-wks/directdisk-gpt.wks            | 0
 {scripts/lib => src}/wic/canned-wks/directdisk-multi-rootfs.wks   | 0
 {scripts/lib => src}/wic/canned-wks/directdisk.wks                | 0
 {scripts/lib => src}/wic/canned-wks/efi-bootdisk.wks.in           | 0
 {scripts/lib => src}/wic/canned-wks/efi-uki-bootdisk.wks.in       | 0
 {scripts/lib => src}/wic/canned-wks/mkefidisk.wks                 | 0
 {scripts/lib => src}/wic/canned-wks/mkhybridiso.wks               | 0
 {scripts/lib => src}/wic/canned-wks/qemuloongarch.wks             | 0
 {scripts/lib => src}/wic/canned-wks/qemuriscv.wks                 | 0
 {scripts/lib => src}/wic/canned-wks/qemux86-directdisk.wks        | 0
 {scripts/lib => src}/wic/canned-wks/sdimage-bootpart.wks          | 0
 {scripts/lib => src}/wic/canned-wks/systemd-bootdisk.wks          | 0
 scripts/wic => src/wic/cli.py                                     | 0
 {scripts/lib => src}/wic/engine.py                                | 0
 {scripts/lib => src}/wic/filemap.py                               | 0
 {scripts/lib => src}/wic/help.py                                  | 0
 {scripts/lib => src}/wic/ksparser.py                              | 0
 {scripts/lib => src}/wic/misc.py                                  | 0
 {scripts/lib => src}/wic/partition.py                             | 0
 {scripts/lib => src}/wic/pluginbase.py                            | 0
 {scripts/lib => src}/wic/plugins/imager/direct.py                 | 0
 {scripts/lib => src}/wic/plugins/source/bootimg_biosplusefi.py    | 0
 {scripts/lib => src}/wic/plugins/source/bootimg_efi.py            | 0
 {scripts/lib => src}/wic/plugins/source/bootimg_partition.py      | 0
 {scripts/lib => src}/wic/plugins/source/bootimg_pcbios.py         | 0
 {scripts/lib => src}/wic/plugins/source/empty.py                  | 0
 {scripts/lib => src}/wic/plugins/source/extra_partition.py        | 0
 {scripts/lib => src}/wic/plugins/source/isoimage_isohybrid.py     | 0
 {scripts/lib => src}/wic/plugins/source/rawcopy.py                | 0
 {scripts/lib => src}/wic/plugins/source/rootfs.py                 | 0
 34 files changed, 0 insertions(+), 0 deletions(-)
 rename {scripts/lib => src}/wic/__init__.py (100%)
 rename {scripts/lib => src}/wic/canned-wks/common.wks.inc (100%)
 rename {scripts/lib => src}/wic/canned-wks/directdisk-bootloader-config.cfg (100%)
 rename {scripts/lib => src}/wic/canned-wks/directdisk-bootloader-config.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/directdisk-gpt.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/directdisk-multi-rootfs.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/directdisk.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/efi-bootdisk.wks.in (100%)
 rename {scripts/lib => src}/wic/canned-wks/efi-uki-bootdisk.wks.in (100%)
 rename {scripts/lib => src}/wic/canned-wks/mkefidisk.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/mkhybridiso.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/qemuloongarch.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/qemuriscv.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/qemux86-directdisk.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/sdimage-bootpart.wks (100%)
 rename {scripts/lib => src}/wic/canned-wks/systemd-bootdisk.wks (100%)
 rename scripts/wic => src/wic/cli.py (100%)
 rename {scripts/lib => src}/wic/engine.py (100%)
 rename {scripts/lib => src}/wic/filemap.py (100%)
 rename {scripts/lib => src}/wic/help.py (100%)
 rename {scripts/lib => src}/wic/ksparser.py (100%)
 rename {scripts/lib => src}/wic/misc.py (100%)
 rename {scripts/lib => src}/wic/partition.py (100%)
 rename {scripts/lib => src}/wic/pluginbase.py (100%)
 rename {scripts/lib => src}/wic/plugins/imager/direct.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_biosplusefi.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_efi.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_partition.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/bootimg_pcbios.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/empty.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/extra_partition.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/isoimage_isohybrid.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/rawcopy.py (100%)
 rename {scripts/lib => src}/wic/plugins/source/rootfs.py (100%)
src/wic/__init__.py renamed from scripts/lib/wic/__init__.py +0 -0
similarity index 100%
rename from scripts/lib/wic/__init__.py
rename to src/wic/__init__.py
src/wic/canned-wks/common.wks.inc renamed from scripts/lib/wic/canned-wks/common.wks.inc +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/common.wks.inc
rename to src/wic/canned-wks/common.wks.inc
src/wic/canned-wks/directdisk-bootloader-config.cfg renamed from scripts/lib/wic/canned-wks/directdisk-bootloader-config.cfg +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/directdisk-bootloader-config.cfg
rename to src/wic/canned-wks/directdisk-bootloader-config.cfg
src/wic/canned-wks/directdisk-bootloader-config.wks renamed from scripts/lib/wic/canned-wks/directdisk-bootloader-config.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/directdisk-bootloader-config.wks
rename to src/wic/canned-wks/directdisk-bootloader-config.wks
src/wic/canned-wks/directdisk-gpt.wks renamed from scripts/lib/wic/canned-wks/directdisk-gpt.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/directdisk-gpt.wks
rename to src/wic/canned-wks/directdisk-gpt.wks
src/wic/canned-wks/directdisk-multi-rootfs.wks renamed from scripts/lib/wic/canned-wks/directdisk-multi-rootfs.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/directdisk-multi-rootfs.wks
rename to src/wic/canned-wks/directdisk-multi-rootfs.wks
src/wic/canned-wks/directdisk.wks renamed from scripts/lib/wic/canned-wks/directdisk.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/directdisk.wks
rename to src/wic/canned-wks/directdisk.wks
src/wic/canned-wks/efi-bootdisk.wks.in renamed from scripts/lib/wic/canned-wks/efi-bootdisk.wks.in +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/efi-bootdisk.wks.in
rename to src/wic/canned-wks/efi-bootdisk.wks.in
src/wic/canned-wks/efi-uki-bootdisk.wks.in renamed from scripts/lib/wic/canned-wks/efi-uki-bootdisk.wks.in +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/efi-uki-bootdisk.wks.in
rename to src/wic/canned-wks/efi-uki-bootdisk.wks.in
src/wic/canned-wks/mkefidisk.wks renamed from scripts/lib/wic/canned-wks/mkefidisk.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/mkefidisk.wks
rename to src/wic/canned-wks/mkefidisk.wks
src/wic/canned-wks/mkhybridiso.wks renamed from scripts/lib/wic/canned-wks/mkhybridiso.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/mkhybridiso.wks
rename to src/wic/canned-wks/mkhybridiso.wks
src/wic/canned-wks/qemuloongarch.wks renamed from scripts/lib/wic/canned-wks/qemuloongarch.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/qemuloongarch.wks
rename to src/wic/canned-wks/qemuloongarch.wks
src/wic/canned-wks/qemuriscv.wks renamed from scripts/lib/wic/canned-wks/qemuriscv.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/qemuriscv.wks
rename to src/wic/canned-wks/qemuriscv.wks
src/wic/canned-wks/qemux86-directdisk.wks renamed from scripts/lib/wic/canned-wks/qemux86-directdisk.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/qemux86-directdisk.wks
rename to src/wic/canned-wks/qemux86-directdisk.wks
src/wic/canned-wks/sdimage-bootpart.wks renamed from scripts/lib/wic/canned-wks/sdimage-bootpart.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/sdimage-bootpart.wks
rename to src/wic/canned-wks/sdimage-bootpart.wks
src/wic/canned-wks/systemd-bootdisk.wks renamed from scripts/lib/wic/canned-wks/systemd-bootdisk.wks +0 -0
similarity index 100%
rename from scripts/lib/wic/canned-wks/systemd-bootdisk.wks
rename to src/wic/canned-wks/systemd-bootdisk.wks
src/wic/cli.py renamed from scripts/wic +0 -0
similarity index 100%
rename from scripts/wic
rename to src/wic/cli.py
src/wic/engine.py renamed from scripts/lib/wic/engine.py +0 -0
similarity index 100%
rename from scripts/lib/wic/engine.py
rename to src/wic/engine.py
src/wic/filemap.py renamed from scripts/lib/wic/filemap.py +0 -0
similarity index 100%
rename from scripts/lib/wic/filemap.py
rename to src/wic/filemap.py
src/wic/help.py renamed from scripts/lib/wic/help.py +0 -0
similarity index 100%
rename from scripts/lib/wic/help.py
rename to src/wic/help.py
src/wic/ksparser.py renamed from scripts/lib/wic/ksparser.py +0 -0
similarity index 100%
rename from scripts/lib/wic/ksparser.py
rename to src/wic/ksparser.py
src/wic/misc.py renamed from scripts/lib/wic/misc.py +0 -0
similarity index 100%
rename from scripts/lib/wic/misc.py
rename to src/wic/misc.py
src/wic/partition.py renamed from scripts/lib/wic/partition.py +0 -0
similarity index 100%
rename from scripts/lib/wic/partition.py
rename to src/wic/partition.py
src/wic/pluginbase.py renamed from scripts/lib/wic/pluginbase.py +0 -0
similarity index 100%
rename from scripts/lib/wic/pluginbase.py
rename to src/wic/pluginbase.py
src/wic/plugins/imager/direct.py renamed from scripts/lib/wic/plugins/imager/direct.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/imager/direct.py
rename to src/wic/plugins/imager/direct.py
src/wic/plugins/source/bootimg_biosplusefi.py renamed from scripts/lib/wic/plugins/source/bootimg_biosplusefi.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/bootimg_biosplusefi.py
rename to src/wic/plugins/source/bootimg_biosplusefi.py
src/wic/plugins/source/bootimg_efi.py renamed from scripts/lib/wic/plugins/source/bootimg_efi.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/bootimg_efi.py
rename to src/wic/plugins/source/bootimg_efi.py
src/wic/plugins/source/bootimg_partition.py renamed from scripts/lib/wic/plugins/source/bootimg_partition.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/bootimg_partition.py
rename to src/wic/plugins/source/bootimg_partition.py
src/wic/plugins/source/bootimg_pcbios.py renamed from scripts/lib/wic/plugins/source/bootimg_pcbios.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/bootimg_pcbios.py
rename to src/wic/plugins/source/bootimg_pcbios.py
src/wic/plugins/source/empty.py renamed from scripts/lib/wic/plugins/source/empty.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/empty.py
rename to src/wic/plugins/source/empty.py
src/wic/plugins/source/extra_partition.py renamed from scripts/lib/wic/plugins/source/extra_partition.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/extra_partition.py
rename to src/wic/plugins/source/extra_partition.py
src/wic/plugins/source/isoimage_isohybrid.py renamed from scripts/lib/wic/plugins/source/isoimage_isohybrid.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/isoimage_isohybrid.py
rename to src/wic/plugins/source/isoimage_isohybrid.py
src/wic/plugins/source/rawcopy.py renamed from scripts/lib/wic/plugins/source/rawcopy.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/rawcopy.py
rename to src/wic/plugins/source/rawcopy.py
src/wic/plugins/source/rootfs.py renamed from scripts/lib/wic/plugins/source/rootfs.py +0 -0
similarity index 100%
rename from scripts/lib/wic/plugins/source/rootfs.py
rename to src/wic/plugins/source/rootfs.py
Signature · 1 line
2.51.0
#2 lore raw

PATCH 2/9 move example *wks files

In reply to Trevor Woerner

These canned *wks files come directly from the OpenEmbedded project, are only relevant to that project, and therefore should be preserved there. Instead of removing them, keep them around as example *wks files for this project.

However, move them away from a location (relative to the wic invoking script itself, cli.py) so they do not accidentally interfere with any usage of this tool.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

---
 {src/wic/canned-wks => example-wks}/common.wks.inc                | 0
 .../canned-wks => example-wks}/directdisk-bootloader-config.cfg   | 0
 .../canned-wks => example-wks}/directdisk-bootloader-config.wks   | 0
 {src/wic/canned-wks => example-wks}/directdisk-gpt.wks            | 0
 {src/wic/canned-wks => example-wks}/directdisk-multi-rootfs.wks   | 0
 {src/wic/canned-wks => example-wks}/directdisk.wks                | 0
 {src/wic/canned-wks => example-wks}/efi-bootdisk.wks.in           | 0
 {src/wic/canned-wks => example-wks}/efi-uki-bootdisk.wks.in       | 0
 {src/wic/canned-wks => example-wks}/mkefidisk.wks                 | 0
 {src/wic/canned-wks => example-wks}/mkhybridiso.wks               | 0
 {src/wic/canned-wks => example-wks}/qemuloongarch.wks             | 0
 {src/wic/canned-wks => example-wks}/qemuriscv.wks                 | 0
 {src/wic/canned-wks => example-wks}/qemux86-directdisk.wks        | 0
 {src/wic/canned-wks => example-wks}/sdimage-bootpart.wks          | 0
 {src/wic/canned-wks => example-wks}/systemd-bootdisk.wks          | 0
 15 files changed, 0 insertions(+), 0 deletions(-)
 rename {src/wic/canned-wks => example-wks}/common.wks.inc (100%)
 rename {src/wic/canned-wks => example-wks}/directdisk-bootloader-config.cfg (100%)
 rename {src/wic/canned-wks => example-wks}/directdisk-bootloader-config.wks (100%)
 rename {src/wic/canned-wks => example-wks}/directdisk-gpt.wks (100%)
 rename {src/wic/canned-wks => example-wks}/directdisk-multi-rootfs.wks (100%)
 rename {src/wic/canned-wks => example-wks}/directdisk.wks (100%)
 rename {src/wic/canned-wks => example-wks}/efi-bootdisk.wks.in (100%)
 rename {src/wic/canned-wks => example-wks}/efi-uki-bootdisk.wks.in (100%)
 rename {src/wic/canned-wks => example-wks}/mkefidisk.wks (100%)
 rename {src/wic/canned-wks => example-wks}/mkhybridiso.wks (100%)
 rename {src/wic/canned-wks => example-wks}/qemuloongarch.wks (100%)
 rename {src/wic/canned-wks => example-wks}/qemuriscv.wks (100%)
 rename {src/wic/canned-wks => example-wks}/qemux86-directdisk.wks (100%)
 rename {src/wic/canned-wks => example-wks}/sdimage-bootpart.wks (100%)
 rename {src/wic/canned-wks => example-wks}/systemd-bootdisk.wks (100%)
example-wks/common.wks.inc renamed from src/wic/canned-wks/common.wks.inc +0 -0
similarity index 100%
rename from src/wic/canned-wks/common.wks.inc
rename to example-wks/common.wks.inc
example-wks/directdisk-bootloader-config.cfg renamed from src/wic/canned-wks/directdisk-bootloader-config.cfg +0 -0
similarity index 100%
rename from src/wic/canned-wks/directdisk-bootloader-config.cfg
rename to example-wks/directdisk-bootloader-config.cfg
example-wks/directdisk-bootloader-config.wks renamed from src/wic/canned-wks/directdisk-bootloader-config.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/directdisk-bootloader-config.wks
rename to example-wks/directdisk-bootloader-config.wks
example-wks/directdisk-gpt.wks renamed from src/wic/canned-wks/directdisk-gpt.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/directdisk-gpt.wks
rename to example-wks/directdisk-gpt.wks
example-wks/directdisk-multi-rootfs.wks renamed from src/wic/canned-wks/directdisk-multi-rootfs.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/directdisk-multi-rootfs.wks
rename to example-wks/directdisk-multi-rootfs.wks
example-wks/directdisk.wks renamed from src/wic/canned-wks/directdisk.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/directdisk.wks
rename to example-wks/directdisk.wks
example-wks/efi-bootdisk.wks.in renamed from src/wic/canned-wks/efi-bootdisk.wks.in +0 -0
similarity index 100%
rename from src/wic/canned-wks/efi-bootdisk.wks.in
rename to example-wks/efi-bootdisk.wks.in
example-wks/efi-uki-bootdisk.wks.in renamed from src/wic/canned-wks/efi-uki-bootdisk.wks.in +0 -0
similarity index 100%
rename from src/wic/canned-wks/efi-uki-bootdisk.wks.in
rename to example-wks/efi-uki-bootdisk.wks.in
example-wks/mkefidisk.wks renamed from src/wic/canned-wks/mkefidisk.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/mkefidisk.wks
rename to example-wks/mkefidisk.wks
example-wks/mkhybridiso.wks renamed from src/wic/canned-wks/mkhybridiso.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/mkhybridiso.wks
rename to example-wks/mkhybridiso.wks
example-wks/qemuloongarch.wks renamed from src/wic/canned-wks/qemuloongarch.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/qemuloongarch.wks
rename to example-wks/qemuloongarch.wks
example-wks/qemuriscv.wks renamed from src/wic/canned-wks/qemuriscv.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/qemuriscv.wks
rename to example-wks/qemuriscv.wks
example-wks/qemux86-directdisk.wks renamed from src/wic/canned-wks/qemux86-directdisk.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/qemux86-directdisk.wks
rename to example-wks/qemux86-directdisk.wks
example-wks/sdimage-bootpart.wks renamed from src/wic/canned-wks/sdimage-bootpart.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/sdimage-bootpart.wks
rename to example-wks/sdimage-bootpart.wks
example-wks/systemd-bootdisk.wks renamed from src/wic/canned-wks/systemd-bootdisk.wks +0 -0
similarity index 100%
rename from src/wic/canned-wks/systemd-bootdisk.wks
rename to example-wks/systemd-bootdisk.wks
Signature · 1 line
2.51.0
#3 lore raw

PATCH 3/9 create python hatch project

In reply to Trevor Woerner

Add the pieces necessary to convert this project into a standard Python hatch package.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

---
 .gitignore     |   1 +
 LICENSE        | 288 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md      |  51 +++++++++
 pyproject.toml |  38 +++++++
 4 files changed, 378 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 LICENSE
 create mode 100644 README.md
 create mode 100644 pyproject.toml
.gitignore new file +1 -0
new file mode 100644
index 000000000000..eeb8a6ec4087
@@ -0,0 +1 @@
+**/__pycache__
LICENSE new file +288 -0

288 lines not on this page · raw message

README.md new file +51 -0

51 lines not on this page · raw message

pyproject.toml new file +38 -0
new file mode 100644
index 000000000000..fdc1ce0f5ece
@@ -0,0 +1,38 @@
+[project]
+name = "wic"
+description = "OpenEmbedded Image Creator (wic) packaged as a standalone CLI"
+dynamic = ["version"]
+readme = "README.md"
+license = { text = "GPL-2.0-only" }
+maintainers = [
+    { name = "Trevor Woerner", email = "[email protected]" },
+]
+requires-python = ">=3.8"
+classifiers = [
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Build Tools",
+  "Topic :: Software Development :: Embedded Systems",
+  "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+]
+
+[project.urls]
+Homepage = "https://git.yoctoproject.org/wic"
+Repository = "https://git.yoctoproject.org/wic"
+
+[project.scripts]
+wic = "wic.cli:main"
+
+[tool.hatch.build]
+packages = ["src/wic"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/wic"]
+
+[build-system]
+requires = ["hatchling>=1.21"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/wic/cli.py"
Signature · 1 line
2.51.0
#4 lore raw

PATCH 4/9 add oe-core and bitbake helper packages

In reply to Trevor Woerner

When it was part of oe-core, wic used a couple packages from bitbake and oe-core. Import those packages, with minor tweaks, so that the independent wic will be able to function.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

---
 pyproject.toml      |   4 +-
 src/bb/__init__.py  |  14 ++
 src/bb/utils.py     |  23 +++
 src/oe/__init__.py  |   1 +
 src/oe/bootfiles.py |  58 ++++++++
 src/oe/path.py      | 351 ++++++++++++++++++++++++++++++++++++++++++++
 6 files changed, 449 insertions(+), 2 deletions(-)
 create mode 100644 src/bb/__init__.py
 create mode 100644 src/bb/utils.py
 create mode 100644 src/oe/__init__.py
 create mode 100644 src/oe/bootfiles.py
 create mode 100644 src/oe/path.py
pyproject.toml +2 -2
index fdc1ce0f5ece..6ef29462f3f5 100644
@@ -25,10 +25,10 @@ Repository = "https://git.yoctoproject.org/wic"
 wic = "wic.cli:main"
 
 [tool.hatch.build]
-packages = ["src/wic"]
+packages = ["src/wic", "src/oe", "src/bb"]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/wic"]
+packages = ["src/wic", "src/oe", "src/bb"]
 
 [build-system]
 requires = ["hatchling>=1.21"]
src/bb/__init__.py new file +14 -0
new file mode 100644
index 000000000000..d83315486080
@@ -0,0 +1,14 @@
+"""
+Minimal stub of BitBake's bb module for standalone wic.
+Provides debug logging used by vendored oe helpers.
+"""
+import logging
+
+def debug(level, msg):
+    """
+    Mirror bb.debug signature but route to standard logging.
+    """
+    logging.getLogger("bb").debug(msg)
+
+# Expose utils so callers can access bb.utils.mkdirhier
+from . import utils
src/bb/utils.py new file +23 -0
new file mode 100644
index 000000000000..3750056ba563
@@ -0,0 +1,23 @@
+"""
+Minimal subset of BitBake's bb.utils used by standalone wic.
+"""
+import os
+
+# from bitbake/lib/bb/utils.py
+def mkdirhier(directory):
+    """Create a directory like 'mkdir -p', but does not complain if
+    directory already exists list ``os.makedirs()``.
+
+    Arguments:
+
+    - ``directory``: path to the directory.
+
+    No return value.
+    """
+    if '${' in str(directory):
+        raise Exception("Directory name {} contains unexpanded bitbake variable. This may cause build failures and WORKDIR polution.".format(directory))
+    try:
+        os.makedirs(directory, exist_ok=True)
+    except OSError as e:
+        if e.errno != errno.EEXIST or not os.path.isdir(directory):
+            raise e
src/oe/__init__.py new file +1 -0
new file mode 100644
index 000000000000..abefaa7a8f58
@@ -0,0 +1 @@
+# Minimal vendored OpenEmbedded helpers used by wic.
src/oe/bootfiles.py new file +58 -0

58 lines not on this page · raw message

src/oe/path.py new file +351 -0

351 lines not on this page · raw message

Signature · 1 line
2.51.0
#6 lore raw

PATCH 6/9 cli.py: remove bitbake coupling

In reply to Trevor Woerner

The code that is being removed in this commit uses the scriptpath module to add more paths to sys.path in order to find oe-core-specific and bitbake-specific modules by using relative paths. In other words, this code assumes it is located within oe-core or bitbake. By splitting out wic, it is no longer located where these relative searches have any chance of working, therefore remove this coupling.

Additionally, the bitbake_path variable does not appear to be used anywhere, so it is removed as well.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

---
 src/wic/cli.py | 7 -------
 1 file changed, 7 deletions(-)
src/wic/cli.py +0 -7
index 9de5efbb5aec..04b2ad25cac5 100755
@@ -28,10 +28,6 @@ from collections import namedtuple
 
 # External modules
 scripts_path = os.path.dirname(os.path.realpath(__file__))
-lib_path = scripts_path + '/lib'
-sys.path.insert(0, lib_path)
-import scriptpath
-scriptpath.add_oe_lib_path()
 
 # Check whether wic is running within eSDK environment
 sdkroot = scripts_path
@@ -48,9 +44,6 @@ if os.environ.get('SDKTARGETSYSROOT'):
         sdkroot = os.path.dirname(sdkroot)
 
 bitbake_exe = shutil.which('bitbake')
-if bitbake_exe:
-    bitbake_path = scriptpath.add_bitbake_lib_path()
-    import bb
 
 from wic import WicError
 from wic.misc import get_bitbake_var, BB_VARS
Signature · 1 line
2.51.0
#5 lore raw

PATCH 5/9 bump version: 0.2.0 -> 0.3.0

In reply to Trevor Woerner

Now that wic is its own standalone tool, bump the version to make the change explicit.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

---
 src/wic/cli.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
src/wic/cli.py +1 -1
index a3402bffcc63..9de5efbb5aec 100755
@@ -14,7 +14,7 @@
 # AUTHORS
 # Tom Zanussi <tom.zanussi (at] linux.intel.com>
 #
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 # Python Standard Library modules
 import os
Signature · 1 line
2.51.0
#7 lore raw

PATCH 7/9 plugins/source/bootimg_biosplusefi.py: add import os

In reply to Trevor Woerner

BitBake's bb/build.py:55 deliberately injects os (and bb) into Python's __builtins__ at the module level:

# When we execute a Python function, we'd like certain things # in all namespaces, hence we add them to __builtins__. # If we do not do this and use the exec globals, they will # not be available to subfunctions.
if hasattr(__builtins__, '__setitem__'):
builtins = __builtins__
else:
builtins = __builtins__.__dict__

builtins['bb'] = bb
builtins['os'] = os

When wic was part of oe-core this injection would occur, and once os is in __builtins__, Python's name resolution (locals -> globals -> builtins) finds it for any code in the process, even modules that never explicitly import os. So when bootimg_biosplusefi.py's __instanciateSubClasses referenced os.path.join(...), Python resolved os from builtins rather than the module's own globals.

Since wic is now split out from oe-core (and bitbake) this plugin fails with:
NameError: name 'os' is not defined.

Therefore, add "import os" to bootimg_biosplusefi.py.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

AI-Generated: codex/claude-opus-4-6 (xhigh)

---
 src/wic/plugins/source/bootimg_biosplusefi.py | 1 +
 1 file changed, 1 insertion(+)
src/wic/plugins/source/bootimg_biosplusefi.py +1 -0
index 4279ddded83a..cd7cd270a970 100644
@@ -19,6 +19,7 @@
 # William Bourque <wbourque [at) gmail.com>
 
 import types
+import os
 
 from wic.pluginbase import SourcePlugin
 from importlib.machinery import SourceFileLoader
Signature · 1 line
2.51.0
#8 lore raw

PATCH 8/9 ksparser.py: search for *inc files

In reply to Trevor Woerner

If a *wks file has an "include" directive, try looking for the include file at the path where the *wks file was found.

NOTE: this commit does not work as-is, but is being provided in order to
explicitly show a clean transition from oe-core

AI-Generated: codex/gpt-5.4 (high)

---
 src/wic/ksparser.py | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)
src/wic/ksparser.py +16 -2
index 4ccd70dc555a..8e5fbfadd81f 100644
@@ -101,6 +101,15 @@ def overheadtype(arg):
 
     return result
 
+def resolve_canned_path(arg, current_confpath=None):
+    if current_confpath:
+        current_dir = os.path.dirname(os.path.abspath(current_confpath))
+        relative_path = os.path.join(current_dir, arg)
+        if os.path.exists(relative_path):
+            return relative_path
+
+    return None
+
 def cannedpathtype(arg):
     """
     Custom type for ArgumentParser
@@ -202,7 +211,7 @@ class KickStart():
         bootloader.add_argument('--source')
 
         include = subparsers.add_parser('include')
-        include.add_argument('path', type=cannedpathtype)
+        include.add_argument('path')
 
         self._parse(parser, confpath)
         if not self.bootloader:
@@ -289,7 +298,12 @@ class KickStart():
                         self.partnum += 1
                         self.partitions.append(Partition(parsed, self.partnum))
                     elif line.startswith('include'):
-                        self._parse(parser, parsed.path)
+                        include_path = resolve_canned_path(parsed.path, confpath)
+                        if not include_path:
+                            err = "%s:%d: argument path: file not found: %s" % \
+                                  (confpath, lineno, parsed.path)
+                            raise KickStartError(err)
+                        self._parse(parser, include_path)
                     elif line.startswith('bootloader'):
                         if not self.bootloader:
                             self.bootloader = parsed
Signature · 1 line
2.51.0
#9 lore raw

PATCH 9/9 cli.py: fix main() for standalone mode

In reply to Trevor Woerner

The generated hatch launcher calls wic.cli.main() with no arguments, but wic defines main(argv). Update main() handling to match.

AI-Generated: codex/gpt-5.4 (high)

---
 src/wic/cli.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
src/wic/cli.py +4 -1
index 04b2ad25cac5..cf3e51e3afad 100755
@@ -590,7 +590,10 @@ class WicArgumentParser(argparse.ArgumentParser):
      def format_help(self):
          return hlp.wic_help
 
-def main(argv):
+def main(argv=None):
+    if argv is None:
+        argv = sys.argv[1:]
+
     parser = WicArgumentParser(
         description="wic version %s" % __version__)
 
Signature · 1 line
2.51.0