Document the limited situations in which ostree-grub2 will work in practice

debian/changelog

@@ -27,6 +27,8 @@ ostree (2016.1+deb-1) UNRELEASED; urgency=medium
   * Redirect libexecdir to /usr/lib (not /usr/lib/${multiarch}) since we don't
     need multiarch for anything that's installed there, fixing a broken
     symlink in ostree-grub2
+  * Document the limited situations in which ostree-grub2 will work in
+    practice
 
  -- Simon McVittie <smcv@debian.org>  Wed, 27 Jan 2016 13:04:34 +0100
 

debian/control

@@ -116,6 +116,7 @@ Description: content-addressed filesystem for operating system binaries
 Package: ostree-grub2
 Architecture: all
 Depends:
+ dracut,
  ${misc:Depends},
 Recommends:
  grub-efi-amd64 | grub-pc,
@@ -126,6 +127,15 @@ Description: GRUB 2 configuration for ostree
  disadvantages) of both.
  .
  This package contains configuration snippets for using ostree with GRUB 2.
+ This integration currently has some limitations:
+ .
+  - the initramfs must have been made using dracut
+  - the root filesystem must be one that dracut can mount without a root=
+    command-line argument (an EFI partition with the GUID defined in
+    the Discoverable Partitions specification)
+  - /boot must be a separate partition
+ .
+ See README.Debian.gz for more details.
 
 Package: ostree-tests
 Architecture: any

debian/ostree-grub2.README.Debian

@@ -0,0 +1,10 @@
+This package contains configuration snippets for using ostree with GRUB 2.
+This integration currently has some limitations:
+
+  - the initramfs must have been made using dracut
+  - the root filesystem must be one that dracut can mount without a root=
+    command-line argument (an EFI partition with the GUID defined in
+    the Discoverable Partitions specification[1])
+  - /boot must be a separate partition
+
+[1] https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/