[pve-devel] [PATCH docs] docs: rename "dirs" parameter, clarify paths
Leo Nunner
l.nunner at proxmox.com
Thu Jan 5 17:16:58 CET 2023
Chagne the name of the "dirs" parameter to "content-dirs" and be less
misleading with "absolute paths".
Signed-off-by: Leo Nunner <l.nunner at proxmox.com>
---
pve-storage-cifs.adoc | 2 +-
pve-storage-dir.adoc | 13 +++++++------
pve-storage-nfs.adoc | 2 +-
3 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/pve-storage-cifs.adoc b/pve-storage-cifs.adoc
index 4d93727..e0d4106 100644
--- a/pve-storage-cifs.adoc
+++ b/pve-storage-cifs.adoc
@@ -57,7 +57,7 @@ path::
The local mount point. Optional, defaults to `/mnt/pve/<STORAGE_ID>/`.
-dirs::
+content-dirs::
Overrides for the default directory layout. Optional.
diff --git a/pve-storage-dir.adoc b/pve-storage-dir.adoc
index ec1b957..cd3fa9e 100644
--- a/pve-storage-dir.adoc
+++ b/pve-storage-dir.adoc
@@ -50,14 +50,15 @@ This backend supports all common storage properties, and adds two
additional properties. The `path` property is used to specify the
directory. This needs to be an absolute file system path.
-The optional `dirs` property allows for the default layout to be
-changed. It consists of a comma-separated list of identifiers in
-the following format:
+The optional `content-dirs` property allows for the default layout
+to be changed. It consists of a comma-separated list of identifiers
+in the following format:
- vtype:path
+ vtype=path
Where `vtype` is one of the allowed content types for the storage, and
-`path` is an absolute file system path.
+`path` is a path relative to the mountpoint of the storage, preceded
+with /.
.Configuration Example (`/etc/pve/storage.cfg`)
----
@@ -66,7 +67,7 @@ dir: backup
content backup
prune-backups keep-last=7
max-protected-backups 3
- dirs backup:/custom/backup/dir
+ content-dirs backup=/custom/backup/dir
----
The above configuration defines a storage pool called `backup`. That pool can be
diff --git a/pve-storage-nfs.adoc b/pve-storage-nfs.adoc
index 95ee45d..ce62aa0 100644
--- a/pve-storage-nfs.adoc
+++ b/pve-storage-nfs.adoc
@@ -40,7 +40,7 @@ path::
The local mount point (defaults to `/mnt/pve/<STORAGE_ID>/`).
-dirs::
+content-dirs::
Overrides for the default directory layout. Optional.
--
2.30.2
More information about the pve-devel
mailing list