[PATCH v2 2/2] bootstd: Replace bootmethod(s) -> bootmeth(s)
Mattijs Korpershoek
mkorpershoek at baylibre.com
Tue Jun 4 17:15:22 CEST 2024
According to [1], we should use bootmeth when describing the
struct bootmeth:
"""
For version 2, a new naming scheme is used as above:
- bootdev is used instead of bootdevice, because 'device' is overused,
is everywhere in U-Boot, can be confused with udevice
- bootmeth - because 'method' is too vanilla, appears 1300 times in
U-Boot
"""
Replace all occurences in various comments for consistency.
[1] https://lore.kernel.org/u-boot/20211023232635.9195-1-sjg@chromium.org/
Signed-off-by: Mattijs Korpershoek <mkorpershoek at baylibre.com>
---
board/sandbox/sandbox.env | 2 +-
boot/bootmeth-uclass.c | 2 +-
include/bootmeth.h | 30 +++++++++++++++---------------
include/extlinux.h | 2 +-
test/boot/bootflow.c | 2 +-
test/boot/bootmeth.c | 6 +++---
6 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/board/sandbox/sandbox.env b/board/sandbox/sandbox.env
index a2c19702d64d..564dce78a898 100644
--- a/board/sandbox/sandbox.env
+++ b/board/sandbox/sandbox.env
@@ -10,7 +10,7 @@ eth6addr=02:00:11:22:33:47
ipaddr=192.0.2.1
/*
- * These are used for distro boot which is not supported. But once bootmethod
+ * These are used for distro boot which is not supported. But once bootmeth
* is provided these will be used again.
*/
bootm_size=0x10000000
diff --git a/boot/bootmeth-uclass.c b/boot/bootmeth-uclass.c
index 1d157d54dbdd..e3475f46b34c 100644
--- a/boot/bootmeth-uclass.c
+++ b/boot/bootmeth-uclass.c
@@ -167,7 +167,7 @@ int bootmeth_setup_iter_order(struct bootflow_iter *iter, bool include_global)
if (pass)
iter->first_glob_method = upto;
/*
- * Get a list of bootmethods, in seq order (i.e. using
+ * Get a list of bootmeths, in seq order (i.e. using
* aliases). There may be gaps so try to count up high
* enough to find them all.
*/
diff --git a/include/bootmeth.h b/include/bootmeth.h
index 529c4d813d82..2570d9593d49 100644
--- a/include/bootmeth.h
+++ b/include/bootmeth.h
@@ -47,7 +47,7 @@ struct bootmeth_ops {
* This may involve reading state from the system, e.g. some data in
* the firmware area.
*
- * @dev: Bootmethod device to check
+ * @dev: Bootmeth device to check
* @buf: Buffer to place the info in (terminator must fit)
* @maxsize: Size of buffer
* Returns: 0 if OK, -ENOSPC is buffer is too small, other -ve error if
@@ -74,7 +74,7 @@ struct bootmeth_ops {
*
* It may update only the flags in @iter
*
- * @dev: Bootmethod device to check against
+ * @dev: Bootmeth device to check against
* @iter: On entry, provides bootdev, hwpart, part
* Return: 0 if OK, -ENOTSUPP if this bootdev is not supported
*/
@@ -83,7 +83,7 @@ struct bootmeth_ops {
/**
* read_bootflow() - read a bootflow for a device
*
- * @dev: Bootmethod device to use
+ * @dev: Bootmeth device to use
* @bflow: On entry, provides dev, hwpart, part and method.
* Returns updated bootflow if found
* Return: 0 if OK, -ve on error
@@ -96,7 +96,7 @@ struct bootmeth_ops {
* This provides a bootflow file to the bootmeth, to see if it is valid.
* If it is, the bootflow is set up accordingly.
*
- * @dev: Bootmethod device to use
+ * @dev: Bootmeth device to use
* @bflow: On entry, provides bootdev.
* Returns updated bootflow if found
* @buf: Buffer containing the possible bootflow file
@@ -111,7 +111,7 @@ struct bootmeth_ops {
*
* Read a file from the same place as the bootflow came from
*
- * @dev: Bootmethod device to use
+ * @dev: Bootmeth device to use
* @bflow: Bootflow providing info on where to read from
* @file_path: Path to file (may be absolute or relative)
* @addr: Address to load file
@@ -126,7 +126,7 @@ struct bootmeth_ops {
/**
* readall() - read all files for a bootflow
*
- * @dev: Bootmethod device to boot
+ * @dev: Bootmeth device to boot
* @bflow: Bootflow to read
* Return: 0 if OK, -EIO on I/O error, other -ve on other error
*/
@@ -135,7 +135,7 @@ struct bootmeth_ops {
/**
* boot() - boot a bootflow
*
- * @dev: Bootmethod device to boot
+ * @dev: Bootmeth device to boot
* @bflow: Bootflow to boot
* Return: does not return on success, since it should boot the
* Operating System. Returns -EFAULT if that fails, -ENOTSUPP if
@@ -158,7 +158,7 @@ struct bootmeth_ops {
* This may involve reading state from the system, e.g. some data in
* the firmware area.
*
- * @dev: Bootmethod device to check
+ * @dev: Bootmeth device to check
* @buf: Buffer to place the info in (terminator must fit)
* @maxsize: Size of buffer
* Returns: 0 if OK, -ENOSPC is buffer is too small, other -ve error if
@@ -185,7 +185,7 @@ int bootmeth_get_state_desc(struct udevice *dev, char *buf, int maxsize);
*
* It may update only the flags in @iter
*
- * @dev: Bootmethod device to check against
+ * @dev: Bootmeth device to check against
* @iter: On entry, provides bootdev, hwpart, part
* Return: 0 if OK, -ENOTSUPP if this bootdev is not supported
*/
@@ -194,7 +194,7 @@ int bootmeth_check(struct udevice *dev, struct bootflow_iter *iter);
/**
* bootmeth_read_bootflow() - set up a bootflow for a device
*
- * @dev: Bootmethod device to check
+ * @dev: Bootmeth device to check
* @bflow: On entry, provides dev, hwpart, part and method.
* Returns updated bootflow if found
* Return: 0 if OK, -ve on error
@@ -207,7 +207,7 @@ int bootmeth_read_bootflow(struct udevice *dev, struct bootflow *bflow);
* This provides a bootflow file to the bootmeth, to see if it is valid.
* If it is, the bootflow is set up accordingly.
*
- * @dev: Bootmethod device to use
+ * @dev: Bootmeth device to use
* @bflow: On entry, provides bootdev.
* Returns updated bootflow if found
* @buf: Buffer containing the possible bootflow file (must be allocated
@@ -223,7 +223,7 @@ int bootmeth_set_bootflow(struct udevice *dev, struct bootflow *bflow,
*
* Read a file from the same place as the bootflow came from
*
- * @dev: Bootmethod device to use
+ * @dev: Bootmeth device to use
* @bflow: Bootflow providing info on where to read from
* @file_path: Path to file (may be absolute or relative)
* @addr: Address to load file
@@ -241,7 +241,7 @@ int bootmeth_read_file(struct udevice *dev, struct bootflow *bflow,
* Some bootmeths delay reading of large files until booting is requested. This
* causes those files to be read.
*
- * @dev: Bootmethod device to use
+ * @dev: Bootmeth device to use
* @bflow: Bootflow to read
* Return: does not return on success, since it should boot the
* Operating System. Returns -EFAULT if that fails, other -ve on
@@ -252,7 +252,7 @@ int bootmeth_read_all(struct udevice *dev, struct bootflow *bflow);
/**
* bootmeth_boot() - boot a bootflow
*
- * @dev: Bootmethod device to boot
+ * @dev: Bootmeth device to boot
* @bflow: Bootflow to boot
* Return: does not return on success, since it should boot the
* Operating System. Returns -EFAULT if that fails, other -ve on
@@ -265,7 +265,7 @@ int bootmeth_boot(struct udevice *dev, struct bootflow *bflow);
*
* This sets up the ordering information in @iter, based on the selected
* ordering of the bootmeths in bootstd_priv->bootmeth_order. If there is no
- * ordering there, then all bootmethods are added
+ * ordering there, then all bootmeths are added
*
* @iter: Iterator to update with the order
* @include_global: true to add the global bootmeths, in which case they appear
diff --git a/include/extlinux.h b/include/extlinux.h
index 721ba46371cc..4d26a0a8ab74 100644
--- a/include/extlinux.h
+++ b/include/extlinux.h
@@ -12,7 +12,7 @@
/**
* struct extlinux_info - useful information for extlinux_getfile()
*
- * @dev: bootmethod device being used to boot
+ * @dev: bootmeth device being used to boot
* @bflow: bootflow being booted
*/
struct extlinux_info {
diff --git a/test/boot/bootflow.c b/test/boot/bootflow.c
index 674d4c05f83f..24f3b5fbe109 100644
--- a/test/boot/bootflow.c
+++ b/test/boot/bootflow.c
@@ -400,7 +400,7 @@ BOOTSTD_TEST(bootflow_system, UT_TESTF_DM | UT_TESTF_SCAN_PDATA |
UT_TESTF_SCAN_FDT);
#endif
-/* Check disabling a bootmethod if it requests it */
+/* Check disabling a bootmeth if it requests it */
static int bootflow_iter_disable(struct unit_test_state *uts)
{
struct udevice *bootstd, *dev;
diff --git a/test/boot/bootmeth.c b/test/boot/bootmeth.c
index e498eee036eb..b9a3f48a95ef 100644
--- a/test/boot/bootmeth.c
+++ b/test/boot/bootmeth.c
@@ -37,7 +37,7 @@ BOOTSTD_TEST(bootmeth_cmd_list, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
/* Check 'bootmeth order' command */
static int bootmeth_cmd_order(struct unit_test_state *uts)
{
- /* Select just one bootmethod */
+ /* Select just one bootmeth */
console_record_reset_enable();
ut_assertok(run_command("bootmeth order extlinux", 0));
ut_assert_console_end();
@@ -138,12 +138,12 @@ static int bootmeth_env(struct unit_test_state *uts)
ut_assertok(bootstd_get_priv(&std));
- /* Select just one bootmethod */
+ /* Select just one bootmeth */
console_record_reset_enable();
ut_assertok(env_set("bootmeths", "extlinux"));
ut_asserteq(1, std->bootmeth_count);
- /* Select an invalid bootmethod */
+ /* Select an invalid bootmeth */
ut_asserteq(1, run_command("setenv bootmeths fred", 0));
ut_assert_nextline("Unknown bootmeth 'fred'");
ut_assert_nextlinen("## Error inserting");
--
2.45.0
More information about the U-Boot
mailing list