From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <l.wagner@proxmox.com>
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))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id 51C10CDA0
 for <pbs-devel@lists.proxmox.com>; Tue, 11 Jul 2023 10:35:03 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id 3B09C20616
 for <pbs-devel@lists.proxmox.com>; Tue, 11 Jul 2023 10:35:03 +0200 (CEST)
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))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS
 for <pbs-devel@lists.proxmox.com>; Tue, 11 Jul 2023 10:35:02 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
 by proxmox-new.maurer-it.com (Proxmox) with ESMTP id D150E42EB1
 for <pbs-devel@lists.proxmox.com>; Tue, 11 Jul 2023 10:35:01 +0200 (CEST)
Message-ID: <bc84c07b-1b7c-7edd-c958-9c96e94bb57e@proxmox.com>
Date: Tue, 11 Jul 2023 10:35:01 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.13.0
To: Proxmox Backup Server development discussion
 <pbs-devel@lists.proxmox.com>, Philipp Hufnagl <p.hufnagl@proxmox.com>
References: <20230711075651.16375-1-p.hufnagl@proxmox.com>
Content-Language: en-US
From: Lukas Wagner <l.wagner@proxmox.com>
In-Reply-To: <20230711075651.16375-1-p.hufnagl@proxmox.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.093 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
 NICE_REPLY_A           -0.089 Looks like a legit reply (A)
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
 T_SCC_BODY_TEXT_LINE    -0.01 -
Subject: Re: [pbs-devel] [PATCH proxmox-backup v3] docs: replace concrete
 device paths with pseudo paths
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
 <pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, 
 <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, 
 <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 11 Jul 2023 08:35:03 -0000

Looks good to me. Consider this:

Reviewed-by: Lukas Wagner <l.wagner@proxmox.com>

On 7/11/23 09:56, Philipp Hufnagl wrote:
> 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.

-- 
- Lukas