Merge pull request #246 from cgwalters/doc-check-fetch

cli: Document that check doesn't fetch layers
containers · Jan 2, 2024 · 6656dab · 6656dab
2 parents d2a2326 + 6021747
commit 6656dab
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/src/cli.rs b/lib/src/cli.rs
@@ -32,6 +32,9 @@ pub(crate) struct UpgradeOpts {
     pub(crate) touch_if_changed: Option<Utf8PathBuf>,
 
     /// Check if an update is available without applying it.
+    ///
+    /// This only downloads an updated manifest and image configuration (i.e. typically kilobyte-sized metadata)
+    /// as opposed to the image layers.
     #[clap(long, conflicts_with = "apply")]
     pub(crate) check: bool,