install: Add /usr/share/doc/bootc/baseimage

cgwalters · cgwalters · commit 1ba69d1a2e2c · 2024-12-20T11:13:40.000-05:00
This directory will contain expected files in the base image. That said, I may change the container import path to auto-create at least the sysroot dir and symlink at some point and these can just be dropped. And for that matter after ostreedev/ostree@9a0acd7 "libostree/deploy: enable composefs by default" we can likely just drop the prepare-root bit too. But for now this is needed. Motivated by improving base image generation from https://gitlab.com/fedora/bootc/tracker/-/issues/32 Signed-off-by: Colin Walters <walters@verbum.org>
diff --git a/Makefile b/Makefile
@@ -25,6 +25,9 @@ install:
 	  fi; \
 	  done
 	install -D -m 0644 -t $(DESTDIR)/$(prefix)/lib/systemd/system systemd/*.service systemd/*.timer systemd/*.path systemd/*.target
+	install -D -m 0644 -t $(DESTDIR)/$(prefix)/share/doc/bootc/baseimage/base/usr/lib/ostree/ baseimage/base/usr/lib/ostree/prepare-root.conf
+	install -d -m 755 $(DESTDIR)/$(prefix)/share/doc/bootc/baseimage/base/sysroot
+	cp -PfT baseimage/base/ostree $(DESTDIR)/$(prefix)/share/doc/bootc/baseimage/base/ostree 
 
 # Run this to also take over the functionality of `ostree container` for example.
 # Only needed for OS/distros that have callers invoking `ostree container` and not bootc.
diff --git a/baseimage/README.md b/baseimage/README.md
@@ -0,0 +1,10 @@
+# Recommended image content
+
+The subdirectories here are recommended to be installed alongside
+bootc in `/usr/share/doc/bootc/baseimage` - they act as reference
+sources of content.
+
+- [base](base): At the current time the content here is effectively
+  a hard requirement. It's not much, just an ostree configuration
+  enabling composefs, plus the default `sysroot` directory (which
+  may go away in the future) and the `ostree` symlink into `sysroot`.
diff --git a/baseimage/base/ostree b/baseimage/base/ostree
@@ -0,0 +1 @@
+sysroot/ostree
diff --git a/baseimage/base/sysroot/.gitignore b/baseimage/base/sysroot/.gitignore
@@ -0,0 +1,3 @@
+# A trick to keep an empty directory in git
+*
+!.gitignore
diff --git a/baseimage/base/usr/lib/ostree/prepare-root.conf b/baseimage/base/usr/lib/ostree/prepare-root.conf
@@ -0,0 +1,2 @@
+[composefs]
+enabled = true
diff --git a/contrib/packaging/bootc.spec b/contrib/packaging/bootc.spec
@@ -32,6 +32,7 @@ BuildRequires: libzstd-devel
 %{_prefix}/lib/systemd/system-generators/*
 %{_prefix}/lib/bootc
 %{_unitdir}/*
+%{_docdir}/bootc/*
 %{_mandir}/man*/bootc*
 
 %prep

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# A trick to keep an empty directory in git`
	`2`	`+*`
	`3`	`+!.gitignore`