From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Fri, 29 Mar 2024 12:01:00 +0000 (+0100)
Subject: doc: improve description of FAT partition name generation
X-Git-Tag: v2025.01-rc5-pxa1908~598^2~11
X-Git-Url: http://git.dujemihanovic.xyz/html/%7B%7B%20.Permalink%20%7D%7D?a=commitdiff_plain;h=73d533b2441e862f5d946883356f9a69f09d1422;p=u-boot.git

doc: improve description of FAT partition name generation

List all prefix currently used for generating FAT partition names.
Describe which device class uses which prefix.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---

diff --git a/doc/usage/partitions.rst b/doc/usage/partitions.rst
index 628469bbec..acf4573097 100644
--- a/doc/usage/partitions.rst
+++ b/doc/usage/partitions.rst
@@ -44,9 +44,20 @@ partname
                 <devtype><devletter><partnum>
 
         devtype
-                A device type like ``mmcsd`` or ``hd``. See the
-                ``part_set_generic_name`` function in ``disk/part.c`` for a
-                complete list.
+                The devtype field is set in dependence of the device class:
+
+                ======= ===============
+                devtype device class
+                ======= ===============
+                hd      IDE or SATA
+                sd      SCSI
+                usbd    USB
+                mmcsd   eMMC or SD-card
+                xx      others
+                ======= ===============
+
+                See the ``part_set_generic_name`` function in ``disk/part.c``
+                for the complete list.
 
         devletter
                 The device number as an offset from ``a``. For example, device