5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-03 01:17:49 +03:00

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>
This commit is contained in:
Leo Nunner 2023-01-05 17:16:58 +01:00 committed by Wolfgang Bumiller
parent 432750f71e
commit 93ee25d0be
3 changed files with 9 additions and 8 deletions

View File

@ -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.

View File

@ -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

View File

@ -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.