PBE-DEPLOY(1)

💖 PBE(1) — the pbe deploy era 💖

okay bestie, welcome to PBE, section 1 of the manual. this is the part where we talk about pbe deploy, and honestly? it's giving main character energy. ✨

🌸 COMMAND pbe deploy 🌸

first things first, the vibe check — here's the whole usage line, copied with love and zero typos:

pbe deploy [-h] [-q] [-d] [--kernel-src KSRC] [--local-build]
[--tmpdir-path TMPDIR_PATH] [--keep-tmpdir] [-H HOSTNAME] [-U USERNAME]
[-K PRIVKEY] [-T TIMEOUT]

so what does it do? it compiles and deploys pbe drivers to the SUT (System Under Test), and that SUT can be can be either local or a remote host, depending on the -H option. 💅

by default, literally everything gets built on the SUT. but if you're feeling independent, --local-build lets you build on your own local system instead. 🎀

and where do we go looking for these drivers? great question, bestie. on the local host, pbe searches these directories, in this exact order:

1. ./drivers/idle
2. $WULT_DATA_PATH/drivers/idle
3. $HOME/.local/share/wult/drivers/idle
4. /usr/local/share/wult/drivers/idle
5. /usr/share/wult/drivers/idle

no cap, that's the whole search list. 🦋

✨ OPTIONS pbe deploy ✨

here's every single flag, no skipping, no summarising, we keep it thorough around here. 🫶

• -h — show this help message and exit. the classic "help me pls" button. 😭
• -q — be quiet. shhh. 🤫
• -d — print debugging information. for when you need the tea. 🍓
• --kernel-src KSRC — path to the Linux kernel sources to build drivers against. the default is /lib/modules/$(uname -r)/build on the SUT. and heads up: if --local-build was used, then this path is considered to be on the local system, not the SUT. 📁
• --drivers-make-opts — options and variables to pass to make when the drivers are built. for example, pass CC=clang LLVM=1 to use clang and LLVM tools for building the drivers (this is required when the kernel was build with clang/LLVM). 🔥
• --local-build — build drivers locally, instead of building on HOSTNAME (the SUT). be your own build machine, queen. 👑
• --tmpdir-path TMPDIR_PATH — when pbe is deployed, a random temporary directory is used. use this option to provide a custom path instead. it will be used as a temporary directory on both local and remote hosts. this option is meant for debugging purposes. 🧚
• --keep-tmpdir — do not remove the temporary directories created while deploying pbe. this option is meant for debugging purposes. (the temp dirs stay, like they're moving in permanently. 🏠)
• -H HOSTNAME, --host HOSTNAME — name of the host to run the command on. 🌈
• -U USERNAME, --username USERNAME — name of the user to use for logging into the remote host over SSH. the default user name is root. 💜
• -K PRIVKEY, --priv-key PRIVKEY — path to the private SSH key that should be used for logging into the remote host. by default the key is automatically found from standard paths like ~/.ssh. 🔑✨
• -T TIMEOUT, --timeout TIMEOUT — SSH connect timeout in seconds, default is 8. ⏱️

ok bestie, quick reminder: --tmpdir-path and --keep-tmpdir are both meant for debugging purposes, so don't get too comfy with them in your everyday flow. 🙈

that's the whole page, fr fr. you ate this. periodt. 💅✨

this iconic page is from the PBE manual, dated 2024-05-28, and it signs off as PBE() — mwah, take care of her. 💖🎀🦋