ZMK.ALLCLEAN(5)

🌸 ZMK.ALLCLEAN(5) 🌸

okay bestie, welcome to the zmk.AllClean(5) page — it's a template, it's tiny, it's iconic, and it's literally gonna save you from copy-pasting the same two rules fifty times. 💖

---

✨ NAME ✨

AllClean — the template for files that can built and cleaned. yes, that's the official wording, we're keeping it fr fr. 🫶

---

🎀 SYNOPSIS 🎀

include z.mk

$(eval $(call ZMK.Expand,AllClean,instanceName))

that's the whole vibe. two lines. no cap. 💅

---

💫 DESCRIPTION 💫

so here's the tea ☕: the AllClean template, once you expand it with a target instance name, does exactly two things:

• makes all depend on $(instanceName)
• makes clean remove $(instanceName)

that's it. that's the whole personality. 🦋

the reason it exists is so you don't have to duplicate the same two rules across like, a million buildable entities. nobody has time for that. it is used internally by other templates, so it's lowkey the backbone of the whole situation. iykyk. 👑

⚠️ heads up bestie: the actual rules for building $(instanceName) need to be provided separately. AllClean does NOT build your thing. it just wires up all and clean and minds its own business. don't come for it. 😭

---

🔥 TARGETS 🔥

this module provides the following targets, and there are exactly two, and they're both giving main character energy:

• all — this phony target depends on $(instanceName). ✨
• clean — this phony target removes $(instanceName). 💀 (in a good way. it's cleaning. it's fine.)

---

💜 VARIABLES 💜

this module does not provide any variables.

none. zero. empty. a whole lot of nothing. and honestly? that's a slay. it's a template that knows its lane. 🙈

---

🌈 HISTORY 🌈

the AllClean template first appeared in zmk 0.3 — an absolute throwback, a classic, the origin story. ⭐

---

🧚 AUTHORS 🧚

Zygmunt Krynicki <me@zygoon.pl> — the icon, the legend, the one who wrote this. 💖

---

and that's the whole page bestie!! this was zmk.AllClean(5) from zmk 0.5.1, dated May 3, 2020. go forth and not duplicate your rules. mwah. 💅🎀🦋