From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 604F193965 for ; Thu, 5 Jan 2023 17:17:09 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 45A8D5424 for ; Thu, 5 Jan 2023 17:17:09 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Thu, 5 Jan 2023 17:17:07 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 7EEC6452EA for ; Thu, 5 Jan 2023 17:17:06 +0100 (CET) From: Leo Nunner To: pve-devel@lists.proxmox.com Date: Thu, 5 Jan 2023 17:16:58 +0100 Message-Id: <20230105161658.236402-3-l.nunner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230105161658.236402-1-l.nunner@proxmox.com> References: <20230105161658.236402-1-l.nunner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.027 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH docs] docs: rename "dirs" parameter, clarify paths X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 05 Jan 2023 16:17:09 -0000 Chagne the name of the "dirs" parameter to "content-dirs" and be less misleading with "absolute paths". Signed-off-by: Leo Nunner --- 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//`. -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//`). -dirs:: +content-dirs:: Overrides for the default directory layout. Optional. -- 2.30.2