docs: rename "dirs" parameter, clarify paths

Chagne the name of the "dirs" parameter to "content-dirs" and be less
misleading with "absolute paths".

Signed-off-by: Leo Nunner <l.nunner@proxmox.com>

diff --git a/pve-storage-cifs.adoc b/pve-storage-cifs.adoc
index 4d93727b43dde8d710c699f1ae6ee68d945a5c27..e0d4106b6d5fbd2156af702367b48d78d25ca83a 100644 (file)
--- 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 ec1b9570b31ebb9844c28de82bd06f4b26bd00ed..cd3fa9e03436d2b6ebbeb0c7d6384226dd507be0 100644 (file)
--- 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 95ee45dddeb689f696b5bc1b38d6c9925434b7ac..ce62aa08a30d2d0efb5713a9f961affcb22b239f 100644 (file)
--- 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.