Re: [pbs-devel] [proxmox-backup] Change device names in commands to make it more homogeneous through the documentation

[Lukas Wagner <l.wagner@proxmox.com>]

The changes look good to me and make sense IMO.

Could you maybe send a v2 with the commit message wrapped at 70 chars,
as defined in our contributor guidelines [1]?

Also, the commit subject is quite long as well and should begin with a
subsystem tag. For instance, a good subject for this could be:

docs: replace concrete device paths with pseudo paths

Thanks!

[1] https://pve.proxmox.com/wiki/Developer_Documentation#Commits_and_Commit_Messages

On 7/10/23 10:35, 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