public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Philipp Hufnagl <p.hufnagl@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [proxmox-backup] Change device names in commands to make it more homogeneous through the documentation
Date: Mon, 10 Jul 2023 10:35:37 +0200	[thread overview]
Message-ID: <20230710083537.18703-1-p.hufnagl@proxmox.com> (raw)

Having commonly used device paths (like /dev/sdb) in an example command may cause damage if the user simply copies them without checking. With a pseudo device path (like /dev/sdX), they would simply get an error

Signed-off-by: Philipp Hufnagl <p.hufnagl@proxmox.com>
---
 docs/storage.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/storage.rst b/docs/storage.rst
index f473adbe..60cf268e 100644
--- a/docs/storage.rst
+++ b/docs/storage.rst
@@ -48,12 +48,12 @@ You can create an ``ext4`` or ``xfs`` filesystem on a disk using ``fs
 create``, or by navigating to **Administration -> Storage/Disks -> Directory**
 in the web interface and creating one from there. The following command creates
 an ``ext4`` filesystem and passes the ``--add-datastore`` parameter, in order to
-automatically create a datastore on the disk (in this case ``sdd``). This will
+automatically create a datastore on the disk. This will
 create a datastore at the location ``/mnt/datastore/store1``:
 
 .. code-block:: console
 
-  # proxmox-backup-manager disk fs create store1 --disk sdd --filesystem ext4 --add-datastore true
+  # proxmox-backup-manager disk fs create store1 --disk sdX --filesystem ext4 --add-datastore true
 
 .. image:: images/screenshots/pbs-gui-disks-zfs-create.png
   :align: right
@@ -61,12 +61,12 @@ create a datastore at the location ``/mnt/datastore/store1``:
 
 You can also create a ``zpool`` with various raid levels from **Administration
 -> Storage/Disks -> ZFS** in the web interface, or by using ``zpool create``. The command
-below creates a mirrored ``zpool`` using two disks (``sdb`` & ``sdc``) and
+below creates a mirrored ``zpool`` using two disks and
 mounts it under ``/mnt/datastore/zpool1``:
 
 .. code-block:: console
 
-  # proxmox-backup-manager disk zpool create zpool1 --devices sdb,sdc --raidlevel mirror
+  # proxmox-backup-manager disk zpool create zpool1 --devices sdX,sdY --raidlevel mirror
 
 .. note:: You can also pass the ``--add-datastore`` parameter here, to automatically
   create a datastore from the disk.
-- 
2.39.2





             reply	other threads:[~2023-07-10  8:35 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-10  8:35 Philipp Hufnagl [this message]
2023-07-10 12:02 ` Lukas Wagner

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=20230710083537.18703-1-p.hufnagl@proxmox.com \
    --to=p.hufnagl@proxmox.com \
    --cc=pbs-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal