mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [PATCH 2/3] doc: user: usb: link to syntax when explaining the partition variables
Date: Wed, 25 Jun 2025 12:51:44 +0200	[thread overview]
Message-ID: <20250625105145.3626715-2-rhi@pengutronix.de> (raw)
In-Reply-To: <20250625105145.3626715-1-rhi@pengutronix.de>

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 Documentation/user/usb.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index 7eb360d629c9..43072be53db7 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -51,6 +51,8 @@ the :ref:`command_usbgadget` commands supports registering composite gadgets, wh
 exports multiple functions at once. This happens in the "background" without impacting
 use of the shell.
 
+.. _usbgadget_partitions:
+
 Partition description
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -316,12 +318,16 @@ USB Gadget autostart Options
   See :ref:`command_usbgadget` -a. (Default 0).
 ``global.system.partitions``
   Common function description for all of DFU, fastboot and USB mass storage
-  gadgets. Both Fastboot and DFU partitions also have dedicated override
+  gadgets.
+  See :ref:`usbgadget_partitions` above for the syntax.
+  Both Fastboot and DFU partitions also have dedicated override
   variables for backwards-compatibility:
 
 ``global.usbgadget.dfu_function``
-  Function description for DFU. See :ref:`command_usbgadget` -D [desc].
+  Function description for DFU. See :ref:`command_usbgadget` -D [desc],
+  and :ref:`usbgadget_partitions` above for the syntax.
 ``global.fastboot.partitions``
-  Function description for fastboot. See :ref:`command_usbgadget` -A [desc].
+  Function description for fastboot. See :ref:`command_usbgadget` -A [desc],
+  and :ref:`usbgadget_partitions` above for the syntax.
 ``global.fastboot.bbu``
   Export barebox update handlers. See :ref:`command_usbgadget` -b. (Default 0).
-- 
2.39.5




  reply	other threads:[~2025-06-25 12:32 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-25 10:51 [PATCH 1/3] doc: user: rename appendix section and keep it as last entry Roland Hieber
2025-06-25 10:51 ` Roland Hieber [this message]
2025-06-25 10:51 ` [PATCH 3/3] doc: user: net: document Fastboot over UDP usage Roland Hieber
2025-06-25 12:48   ` Ahmad Fatoum

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=20250625105145.3626715-2-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /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