From: Leo Nunner <l.nunner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH docs] docs: rename "dirs" parameter, clarify paths
Date: Thu, 5 Jan 2023 17:16:58 +0100 [thread overview]
Message-ID: <20230105161658.236402-3-l.nunner@proxmox.com> (raw)
In-Reply-To: <20230105161658.236402-1-l.nunner@proxmox.com>
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>
---
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
next prev parent reply other threads:[~2023-01-05 16:17 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-05 16:16 [pve-devel] [PATCH storage docs] follow-up: change formatting for dir overrides Leo Nunner
2023-01-05 16:16 ` [pve-devel] [PATCH storage] plugin: change name, separator and error message " Leo Nunner
2023-01-05 16:16 ` Leo Nunner [this message]
2023-01-09 9:51 ` [pve-devel] applied: [PATCH storage docs] follow-up: change formatting " Wolfgang Bumiller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230105161658.236402-3-l.nunner@proxmox.com \
--to=l.nunner@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox