From: Simon Glass <sjg@chromium.org>
To: U-Boot Mailing List <u-boot@lists.denx.de>
Cc: "Tom Rini" <trini@konsulko.com>,
"Jonathan A . Kollasch" <jakllsch@kollasch.net>,
"Marek Vasut" <marex@denx.de>,
"Heinrich Schuchardt" <xypron.glpk@gmx.de>,
"Marek Behún" <marek.behun@nic.cz>,
"Eugeniu Rosca" <erosca@de.adit-jv.com>,
"Roland Gaudig" <roland.gaudig@weidmueller.com>,
"Stefan Herbrechtsmeier" <stefan.herbrechtsmeier@weidmueller.com>,
"Sean Anderson" <seanga2@gmail.com>,
"Simon Glass" <sjg@chromium.org>
Subject: [PATCH v2 10/14] doc: Add a note about number representation
Date: Sat, 24 Jul 2021 09:03:37 -0600 [thread overview]
Message-ID: <20210724150341.243074-11-sjg@chromium.org> (raw)
In-Reply-To: <20210724150341.243074-1-sjg@chromium.org>
Mention the default base of U-Boot in the command-line section. Add
examples for decimal and octal.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
(no changes since v1)
doc/usage/cmdline.rst | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/doc/usage/cmdline.rst b/doc/usage/cmdline.rst
index b3dbdb8b230..2d5127c9554 100644
--- a/doc/usage/cmdline.rst
+++ b/doc/usage/cmdline.rst
@@ -54,3 +54,34 @@ General rules
calling run with a list of variables as arguments), any failing
command will cause "run" to terminate, i. e. the remaining
variables are not executed.
+
+Representing numbers
+--------------------
+
+Most U-Boot commands use hexadecimal (hex) as the default base, for convenient
+use of addresses, for example::
+
+ => md 1000 6
+ 00001000: 2c786f62 00697073 03000000 0c000000 box,spi.........
+ 00001010: 67020000 00000000 ...g....
+
+There is no need to add a `0x` prefix to the arguments and the output is shown
+in hex also, without any prefixes. This helps to avoid clutter.
+
+Some commands use decimal where it is more natural::
+
+ => i2c dev 0
+ Setting bus to 0
+ => i2c speed
+ Current bus speed=400000
+ => i2c speed 100000
+ Setting bus speed to 100000 Hz
+
+In some cases the default is decimal but it is possible to use octal if that is
+useful::
+
+ pmic dev pmic@41
+ dev: 1 @ pmic@41
+ => pmic write 2 0177
+ => pmic read 2
+ 0x02: 0x00007f
--
2.32.0.432.gabb21c7263-goog
next prev parent reply other threads:[~2021-07-24 15:06 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-24 15:03 [PATCH v2 00/14] lib: Add support for a decimal 0t prefix for numbers Simon Glass
2021-07-24 15:03 ` [PATCH v2 01/14] hash: Ensure verification hex pairs are terminated Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 02/14] global: Convert simple_strtoul() with hex to hextoul() Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 03/14] global: Convert simple_strtoul() with decimal to dectoul() Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 04/14] lib: Comment the base parameter with simple_strtoul/l() Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 05/14] lib: Drop unnecessary check for hex digit Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 06/14] lib: Add tests for simple_strtoull() Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 07/14] lib: Add octal tests for simple_strtoul/l() Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 08/14] lib: Move common digit-parsing code into a function Simon Glass
2021-08-02 17:51 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 09/14] doc: Convert command-line info to rST Simon Glass
2021-08-02 17:52 ` Tom Rini
2021-07-24 15:03 ` Simon Glass [this message]
2021-08-02 17:52 ` [PATCH v2 10/14] doc: Add a note about number representation Tom Rini
2021-07-24 15:03 ` [PATCH v2 11/14] lib: Allow using 0x when a decimal value is requested Simon Glass
2021-08-02 17:52 ` Tom Rini
2021-07-24 15:03 ` [PATCH v2 12/14] lib: Support a decimal prefix 0n Simon Glass
2021-07-24 15:03 ` [PATCH v2 13/14] lib: Drop octal support Simon Glass
2021-07-24 15:03 ` [PATCH v2 14/14] RFC: Change simple_strtoul() et al to default to hex Simon Glass
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=20210724150341.243074-11-sjg@chromium.org \
--to=sjg@chromium.org \
--cc=erosca@de.adit-jv.com \
--cc=jakllsch@kollasch.net \
--cc=marek.behun@nic.cz \
--cc=marex@denx.de \
--cc=roland.gaudig@weidmueller.com \
--cc=seanga2@gmail.com \
--cc=stefan.herbrechtsmeier@weidmueller.com \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=xypron.glpk@gmx.de \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.