aboutsummaryrefslogtreecommitdiffhomepage
path: root/cmd/mbf
diff options
context:
space:
mode:
authorOphestra <cat@gensokyo.uk>2026-03-28 22:43:25 +0900
committerOphestra <cat@gensokyo.uk>2026-03-28 22:43:25 +0900
commit19c76e08315118b8595abb2d598658b04cf87f78 (patch)
treed518f9954cb153de4730ff2fd0eba540515381a6 /cmd/mbf
parent71fcc972bad6abcd6282f7a80ef5935cdfcf172d (diff)
cmd: document Rosa OS programs
The earlyinit and mbf program are not covered by the compatibility promise, so specify that here. Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'cmd/mbf')
-rw-r--r--cmd/mbf/main.go12
1 files changed, 12 insertions, 0 deletions
diff --git a/cmd/mbf/main.go b/cmd/mbf/main.go
index 16c2cf82..dea07ede 100644
--- a/cmd/mbf/main.go
+++ b/cmd/mbf/main.go
@@ -1,3 +1,15 @@
+// The mbf program is a frontend for [hakurei.app/internal/rosa].
+//
+// This program is not covered by the compatibility promise. The command line
+// interface, available packages and their behaviour, and even the on-disk
+// format, may change at any time.
+//
+// # Name
+//
+// The name mbf stands for maiden's best friend, as a tribute to the DOOM source
+// port of [the same name]. This name is a placeholder and is subject to change.
+//
+// [the same name]: https://www.doomwiki.org/wiki/MBF
package main
import (