GUILT(7)

💖 GUILT(7) — the Guilt Manual 💖

okay bestie, sit down, hydrate, because this is the manual page for guilt, and it is literally quilt on top of git. that's the whole vibe. ✨

---

✨ SYNOPSIS ✨

guilt COMMAND [ARGS]

like. that's it. that's the whole thing. <rainbow>COMMAND</rainbow> and then whatever <rainbow>ARGS</rainbow> that command wants. 💅

---

🌸 DESCRIPTION 🌸

so storytime 🫶 — Andrew Morton originally wrote a bunch of scripts for keeping kernel patches alive outside of any SCM tool. then other people came along and extended them into a whole suite called quilt. the big idea behind quilt is that you maintain patches instead of maintaining source files directly. you can add patches, remove patches, reorder them, and refresh them whenever you fix a bug or bump up to a new base revision. quilt is genuinely powerful, no cap. but 😭 it is not integrated with the underlying SCM tools, and that makes it hard to actually see your changes. it's giving vibes without a mirror.

Guilt fixes that by letting you use quilt functionality right on top of a Git repository. changes are maintained as patches, and those patches get committed into Git. you can remove commits or reorder them, and the underlying patch can be refreshed based on whatever you changed in the working directory. bonus: the patch directory itself can go under revision control, so you get a whole separate history of changes made to your patches. iconic. 👑

---

🎀 PATCHES DIRECTORY 🎀

in Guilt, all the patches live in:

.git/patches/$branch/

where $branch is the name of the branch you're working on. which means ✨ you can have a completely independent series of patches for every branch in the repo. main character energy per branch, fr fr.

each of these per-branch directories contains 3 special files:

• guards — this file contains any guards that should be applied to the series when pushing. it is only present when guards are selected. (so if you don't see it, that's why, don't panic 🫶)
• series — this file contains a list of all the patch filenames relative to the per-branch patch directory. empty lines and commented out lines are ignored. 💅
• status — this file contains the state of the stack. what patches are applied. that's it, that's the tea. 🍓

---

🦋 HOOKS 🦋

any guilt operation may execute zero or more hook scripts. these can run any housekeeping commands you want… or even abort the execution of the command. yes bestie, your hook has veto power. 😭

---

💜 HOOKS DIRECTORY 💜

Guilt follows the same basic design as hooks in Git itself. all Guilt hooks are executable files — generally shell scripts, but honestly they can be anything the operating system can execute — living in:

.git/hooks/guilt/

the following hooks are supported:

• delete <patch name> — executed when a patch is deleted from the patch series via guilt-delete(1).

---

👑 GUILT COMMANDS 👑

all commands must be called without a dash. e.g. guilt add

not me typing guilt-add and wondering why nothing happens 💀 no dash. no. dash.

• guilt-add(1) — guilt-add - Add a file to git and guilt.
• guilt-applied(1) — guilt-applied - List applied patches.
• guilt-branch(1) — guilt-branch - Branch the entire patch series.
• guilt-commit(1) — guilt-commit - Commit specified number of patches.
• guilt-delete(1) — guilt-delete - Delete a patch.
• guilt-diff(1) — guilt-diff - Outputs various diffs.
• guilt-export(1) — guilt-export - Export a patch series (to be used by quilt).
• guilt-files(1) — guilt-files - Print the list of files that the topmost patch changes.
• guilt-fold(1) — guilt-fold - Fold a specified patch into the topmost applied patch.
• guilt-fork(1) — guilt-fork - Fork the topmost applied patch.
• guilt-graph(1) — guilt-graph - Create a patch dependency graph.
• guilt-guard(1) — guilt-guard - Assign guards to patches.
• guilt-header(1) — guilt-header - Print a patch header.
• guilt-help(1) — guilt-help - open man page of a guilt command.
• guilt-import-commit(1) — guilt-import-commit - Import one or more commits as patches.
• guilt-import(1) — guilt-import - Import specified patch file.
• guilt-init(1) — guilt-init - Initialize guilt for use in a git repository.
• guilt-new(1) — guilt-new - Create a new patch.
• guilt-next(1) — guilt-next - Output the name of next patch to be pushed.
• guilt-patchbomb(1) — guilt-patchbomb - Email a series of commits interactively.
• guilt-pop(1) — guilt-pop - Pop patches from the tree.
• guilt-prev(1) — guilt-prev - Output name of second topmost applied patch.
• guilt-push(1) — guilt-push - Push patches onto the tree.
• guilt-rebase(1) — guilt-rebase - Rebase pushed patches.
• guilt-refresh(1) — guilt-refresh - Refresh topmost applied patch.
• guilt-repair(1) — guilt-repair - Repair the repository state.
• guilt-rm(1) — guilt-rm - Remove a file from the git tree and guilt.
• guilt-select(1) — guilt-select - Select guards to apply when pushing patches.
• guilt-series(1) — guilt-series - Print the stack of patches.
• guilt-status(1) — guilt-status - Print the status of files since the last refresh.
• guilt-top(1) — guilt-top - Output name of topmost applied patch.
• guilt-unapplied(1) — guilt-unapplied - List all unapplied patches.

---

🌈 AUTHOR 🌈

Written by Josef "Jeff" Sipek jeffpc@josefsipek.net[1] 💖

---

🎀 DOCUMENTATION 🎀

Documentation by Brandon Philips brandon@ifup.org[2] and Josef "Jeff" Sipek jeffpc@josefsipek.net[1] 🫶

---

⭐ GUILT ⭐

Part of the guilt(7) suite (Generated for Guilt v0.36). yes she's part of a suite, she's that girl. ✨

---

🌸 NOTES 🌸

1. jeffpc@josefsipek.net — mailto:jeffpc@josefsipek.net
2. brandon@ifup.org — mailto:brandon@ifup.org

---

and that's a wrap bestie 🦋 this was Guilt v0.36, dated 01/12/2023 — go push some patches, you've got this 💅💖✨