Docs: Clarify rmi w/ manifest/index use

Also do some minor re-formatting of the `LIMITATIONS` section. Reducing the line-length, and formatting each paragraph into a bullet-item. Signed-off-by: Chris Evich <[email protected]>
containers · Sep 7, 2021 · cb9b9d4 · cb9b9d4
1 parent e90f9ec
commit cb9b9d4
Showing 1 changed file with 14 additions and 4 deletions.
diff --git a/docs/buildah-rmi.md b/docs/buildah-rmi.md
@@ -15,10 +15,20 @@ Passing an argument _image_ deletes it, along with any of its dangling (untagged
 
 ## LIMITATIONS
 
-If the image was pushed to a directory path using the 'dir:' transport
-the rmi command can not remove the image. Instead standard file system
-commands should be used.
-If _imageID_ is a name, but does not include a registry name, buildah will attempt to find and remove an image named using the registry name _localhost_, if no such image is found, it will search for the intended image by attempting to expand the given name using the names of registries provided in the system's registries configuration file, registries.conf.
+* If the image was pushed to a directory path using the 'dir:' transport,
+  the rmi command can not remove the image. Instead, standard file system
+  commands should be used.
+
+* If _imageID_ is a name, but does not include a registry name, buildah will
+  attempt to find and remove the named image using the registry name _localhost_,
+  if no such image is found, it will search for the intended image by attempting
+  to expand the given name using the names of registries provided in the system's
+  registries configuration file, registries.conf.
+
+* If the _imageID_ refers to a *manifest list* or *image index*, this command
+  will ***not*** do what you expect!  This command will remove the images
+  associated with the *manifest list* or *index* (not the manifest list/image index
+  itself). To remove that, use the `buildah manifest rm` subcommand instead.
 
 ## OPTIONS