From 00f1c7f6c49853122b03083ce623dfb9891ad46b Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Fri, 5 Jan 2024 09:38:16 -0700 Subject: [PATCH] Clarify several small items in the mc reference (#1103) A few opportunistic text updates: - `mc mirror` recommends `mc replicate` and `mc admin replicate` for other use cases. Mention what they are for. - Clarify that `mc version` creates a null version id for existing unversioned objects when bucket versioning is enabled. http://192.241.195.202:9000/staging/mc-mirror-clarification/linux/reference/minio-mc/mc-mirror.html http://192.241.195.202:9000/staging/mc-mirror-clarification/linux/reference/minio-mc/mc-version.html#bucket-versioning-with-existing-data --------- Co-authored-by: Ravind Kumar --- source/reference/minio-mc/mc-mirror.rst | 2 +- source/reference/minio-mc/mc-version-enable.rst | 2 +- source/reference/minio-mc/mc-version.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/minio-mc/mc-mirror.rst b/source/reference/minio-mc/mc-mirror.rst index 91103620..c58964bb 100644 --- a/source/reference/minio-mc/mc-mirror.rst +++ b/source/reference/minio-mc/mc-mirror.rst @@ -23,7 +23,7 @@ The :mc:`mc mirror` command synchronizes content to MinIO deployment, similar to .. note:: :mc:`mc mirror` only synchronizes the current object without any version information or metadata. - To synchronize an object's version history and metadata, consider using :mc:`mc replicate` or :mc:`mc admin replicate`. + To synchronize an object's version history and metadata, consider using :mc:`mc replicate` for :ref:`bucket replication ` or :mc:`mc admin replicate` for :ref:`site replication `. .. tab-set:: diff --git a/source/reference/minio-mc/mc-version-enable.rst b/source/reference/minio-mc/mc-version-enable.rst index 6d99f55b..b41606b6 100644 --- a/source/reference/minio-mc/mc-version-enable.rst +++ b/source/reference/minio-mc/mc-version-enable.rst @@ -113,7 +113,7 @@ Behavior Bucket Versioning with Existing Data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Enabling bucket versioning on a bucket with existing data immediately applies a versioning ID to any unversioned object. +Enabling bucket versioning on a bucket with existing data immediately creates a ``NULL`` value version ID for each unversioned object. S3 Compatibility diff --git a/source/reference/minio-mc/mc-version.rst b/source/reference/minio-mc/mc-version.rst index 1abc4056..6c6dd084 100644 --- a/source/reference/minio-mc/mc-version.rst +++ b/source/reference/minio-mc/mc-version.rst @@ -59,7 +59,7 @@ See :mc:`mc retention` for more information on configuring object locking. Bucket Versioning with Existing Data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Enabling bucket versioning on a bucket with existing data immediately applies a versioning ID to any unversioned object. +Enabling bucket versioning on a bucket with existing data immediately creates a null value version ID for each unversioned object. Disabling bucket versioning on a bucket with existing versioned data does *not* remove any versioned objects. Applications can continue to access versioned data after disabling bucket versioning.