From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
by lore.proxmox.com (Postfix) with ESMTPS id 594231FF168
for <inbox@lore.proxmox.com>; Tue, 4 Mar 2025 11:09:29 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 8CCFB1A7A6;
Tue, 4 Mar 2025 11:09:24 +0100 (CET)
From: Daniel Kral <d.kral@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Tue, 4 Mar 2025 11:09:13 +0100
Message-Id: <20250304100915.55114-1-d.kral@proxmox.com>
X-Mailer: git-send-email 2.39.5
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.011 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
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 1/3] storage: make description of storage
CLI examples more consistent
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>
Make the text for `pvesm scan` and `pvesm add` command examples more
consistent by introducing `pvesm scan` with "You can get ... with", as
it is already done for other storage plugins, and changing from past
tense to present tense in existing descriptions for the `pvesm add` as
recommended in the Technical Writing Style Guide for instructions [0].
While at it, replace the term "share" with the more appropriate
"datastore" for the example in the PBS section.
[0] https://pve.proxmox.com/wiki/Technical_Writing_Style_Guide#Second_person_imperative_mood
Signed-off-by: Daniel Kral <d.kral@proxmox.com>
---
pve-storage-cifs.adoc | 2 +-
pve-storage-iscsi.adoc | 2 +-
pve-storage-lvm.adoc | 2 +-
pve-storage-lvmthin.adoc | 2 +-
pve-storage-pbs.adoc | 4 ++--
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/pve-storage-cifs.adoc b/pve-storage-cifs.adoc
index d5d54e7..6b8f35d 100644
--- a/pve-storage-cifs.adoc
+++ b/pve-storage-cifs.adoc
@@ -110,7 +110,7 @@ You can get a list of exported CIFS shares with:
# pvesm scan cifs <server> [--username <username>] [--password]
----
-Then you could add this share as a storage to the whole {pve} cluster
+Then you can add one of these shares as a storage to the whole {pve} cluster
with:
----
diff --git a/pve-storage-iscsi.adoc b/pve-storage-iscsi.adoc
index 55e5b21..aea26d2 100644
--- a/pve-storage-iscsi.adoc
+++ b/pve-storage-iscsi.adoc
@@ -81,7 +81,7 @@ storage on that iSCSI LUN.
Examples
~~~~~~~~
-Scan a remote iSCSI portal, and returns a list of possible targets:
+You can scan a remote iSCSI portal and get a list of possible targets with:
pvesm scan iscsi <HOST[:PORT]>
diff --git a/pve-storage-lvm.adoc b/pve-storage-lvm.adoc
index 487aac6..c100d56 100644
--- a/pve-storage-lvm.adoc
+++ b/pve-storage-lvm.adoc
@@ -88,7 +88,7 @@ not support shared storage.
Examples
~~~~~~~~
-List available volume groups:
+You can get a list of available LVM volume groups with:
# pvesm lvmscan
diff --git a/pve-storage-lvmthin.adoc b/pve-storage-lvmthin.adoc
index f18af63..28ff55f 100644
--- a/pve-storage-lvmthin.adoc
+++ b/pve-storage-lvmthin.adoc
@@ -76,7 +76,7 @@ multiple nodes, so you can only use them as local storage.
Examples
~~~~~~~~
-List available LVM thin pools on volume group `pve`:
+You can get a list of available LVM thin pools on the volume group `pve` with:
# pvesm lvmthinscan pve
diff --git a/pve-storage-pbs.adoc b/pve-storage-pbs.adoc
index d65448d..fafc9c3 100644
--- a/pve-storage-pbs.adoc
+++ b/pve-storage-pbs.adoc
@@ -164,8 +164,8 @@ Example: Add Storage over CLI
//# pvesm scan pbs <server> [--username <username>] [--password]
//----
-Then you could add this share as a storage to the whole {pve} cluster
-with:
+Then you can add one of these datastores as a storage to the whole {pve}
+cluster with:
----
# pvesm add pbs <id> --server <server> --datastore <datastore> --username <username> --fingerprint 00:B4:... --password
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel