nvdimm.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Yi Zhang <yi.zhang@redhat.com>
To: nvdimm@lists.linux.dev
Cc: alison.schofield@intel.com, linux-cxl@vger.kernel.org,
	Dave Jiang <dave.jiang@intel.com>
Subject: [ndctl PATCH v3] ndctl: fix user visible spelling errors
Date: Thu, 14 Aug 2025 06:07:01 -0400	[thread overview]
Message-ID: <20250814100701.2056883-1-yi.zhang@redhat.com> (raw)

The spelling errors are from
- log_err(), fprintf(), dbg() output messages
- echo statemetns in test scripts
- Documentation/*.txt files

Corrected user-visible spelling errors include:
- identifer -> identifier (log_err in cxl/bus.c)
- santize -> sanitize (fprintf in ndctl/dimm.c)
- sucessfully -> successfully (dbg in ndctl/lib/ars.c, ndctl/lib/libndctl.c)
- succeded -> succeeded (echo in test/daxctl-devices.sh)
- Documentation fixes in 4 .txt files

All the spelling errors were identified by the codespell project:
https://github.com/codespell-project/codespell

Reviewed-by: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Yi Zhang <yi.zhang@redhat.com>
---
changes from v2:
- Only fix the user visible spelling errors
changes from v1:
- Add reviewed-by tag
- Add more details about the typos and how they were caught
---
 Documentation/cxl/cxl-reserve-dpa.txt          | 2 +-
 Documentation/cxl/lib/libcxl.txt               | 2 +-
 Documentation/daxctl/daxctl-create-device.txt  | 2 +-
 Documentation/ndctl/ndctl-create-namespace.txt | 4 ++--
 cxl/bus.c                                      | 2 +-
 ndctl/dimm.c                                   | 2 +-
 ndctl/lib/ars.c                                | 4 ++--
 ndctl/lib/libndctl.c                           | 4 ++--
 test/daxctl-devices.sh                         | 4 ++--
 9 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/Documentation/cxl/cxl-reserve-dpa.txt b/Documentation/cxl/cxl-reserve-dpa.txt
index 58cc93e..d51ccd6 100644
--- a/Documentation/cxl/cxl-reserve-dpa.txt
+++ b/Documentation/cxl/cxl-reserve-dpa.txt
@@ -38,7 +38,7 @@ include::bus-option.txt[]
 -t::
 --type::
 	Select the partition for the allocation. CXL devices implement a
-	partition that divdes 'ram' and 'pmem' capacity, where 'pmem' capacity
+	partition that divides 'ram' and 'pmem' capacity, where 'pmem' capacity
 	consumes the higher DPA capacity above the partition boundary. The type
 	defaults to 'pmem'. Note that given CXL DPA allocation constraints, once
 	any 'pmem' allocation is established then all remaining 'ram' capacity
diff --git a/Documentation/cxl/lib/libcxl.txt b/Documentation/cxl/lib/libcxl.txt
index 2a512fd..ce311b1 100644
--- a/Documentation/cxl/lib/libcxl.txt
+++ b/Documentation/cxl/lib/libcxl.txt
@@ -296,7 +296,7 @@ use generic port APIs on root objects.
 Ports are hierarchical. All but the a root object have another CXL port
 as a parent object retrievable via cxl_port_get_parent().
 
-The root port of a hiearchy can be retrieved via any port instance in
+The root port of a hierarchy can be retrieved via any port instance in
 that hierarchy via cxl_port_get_bus().
 
 The host of a port is the corresponding device name of the PCIe Root
diff --git a/Documentation/daxctl/daxctl-create-device.txt b/Documentation/daxctl/daxctl-create-device.txt
index 05f4dbd..b774b86 100644
--- a/Documentation/daxctl/daxctl-create-device.txt
+++ b/Documentation/daxctl/daxctl-create-device.txt
@@ -62,7 +62,7 @@ DESCRIPTION
 -----------
 
 Creates dax device in 'devdax' mode in dynamic regions. The resultant can also
-be convereted to the 'system-ram' mode which arranges for the dax range to be
+be converted to the 'system-ram' mode which arranges for the dax range to be
 hot-plugged into the system as regular memory.
 
 'daxctl create-device' expects that the BIOS or kernel defines a range in the
diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
index afb085e..3d0a2dd 100644
--- a/Documentation/ndctl/ndctl-create-namespace.txt
+++ b/Documentation/ndctl/ndctl-create-namespace.txt
@@ -31,7 +31,7 @@ OPTIONS
 -m::
 --mode=::
 	- "raw": expose the namespace capacity directly with
-	  limitations. A raw pmem namepace namespace does not support
+	  limitations. A raw pmem namespace does not support
 	  sector atomicity (see "sector" mode below). A raw pmem
 	  namespace may have limited to no dax support depending the
 	  kernel. In other words operations like direct-I/O targeting a
@@ -95,7 +95,7 @@ OPTIONS
 	suffixes "k" or "K" for KiB, "m" or "M" for MiB, "g" or "G" for
 	GiB and "t" or "T" for TiB.
 
-	For pmem namepsaces the size must be a multiple of the
+	For pmem namespaces the size must be a multiple of the
 	interleave-width and the namespace alignment (see
 	below).
 
diff --git a/cxl/bus.c b/cxl/bus.c
index 3321295..9ef04bc 100644
--- a/cxl/bus.c
+++ b/cxl/bus.c
@@ -100,7 +100,7 @@ static int bus_action(int argc, const char **argv, struct cxl_ctx *ctx,
 		if (sscanf(argv[i], "%lu", &id) == 1)
 			continue;
 
-		log_err(&bl, "'%s' is not a valid bus identifer\n", argv[i]);
+		log_err(&bl, "'%s' is not a valid bus identifier\n", argv[i]);
 		err++;
 	}
 
diff --git a/ndctl/dimm.c b/ndctl/dimm.c
index aaa0abf..533ab04 100644
--- a/ndctl/dimm.c
+++ b/ndctl/dimm.c
@@ -1074,7 +1074,7 @@ static int action_sanitize_dimm(struct ndctl_dimm *dimm,
 	if (!param.crypto_erase && !param.overwrite) {
 		param.crypto_erase = true;
 		if (param.verbose)
-			fprintf(stderr, "No santize method passed in, default to crypto-erase\n");
+			fprintf(stderr, "No sanitize method passed in, default to crypto-erase\n");
 	}
 
 	if (param.crypto_erase) {
diff --git a/ndctl/lib/ars.c b/ndctl/lib/ars.c
index d50c283..b705cf0 100644
--- a/ndctl/lib/ars.c
+++ b/ndctl/lib/ars.c
@@ -70,7 +70,7 @@ static bool __validate_ars_cap(struct ndctl_cmd *ars_cap)
 ({ \
 	bool __valid = __validate_ars_cap(ars_cap); \
 	if (!__valid) \
-		dbg(ctx, "expected sucessfully completed ars_cap command\n"); \
+		dbg(ctx, "expected successfully completed ars_cap command\n"); \
 	__valid; \
 })
 
@@ -224,7 +224,7 @@ static bool __validate_ars_stat(struct ndctl_cmd *ars_stat)
 ({ \
 	bool __valid = __validate_ars_stat(ars_stat); \
 	if (!__valid) \
-		dbg(ctx, "expected sucessfully completed ars_stat command\n"); \
+		dbg(ctx, "expected successfully completed ars_stat command\n"); \
 	__valid; \
 })
 
diff --git a/ndctl/lib/libndctl.c b/ndctl/lib/libndctl.c
index f75dbd4..0925d6d 100644
--- a/ndctl/lib/libndctl.c
+++ b/ndctl/lib/libndctl.c
@@ -3184,7 +3184,7 @@ NDCTL_EXPORT struct ndctl_cmd *ndctl_dimm_cmd_new_cfg_read(struct ndctl_cmd *cfg
 
 	if (cfg_size->type != ND_CMD_GET_CONFIG_SIZE
 			|| cfg_size->status != 0) {
-		dbg(ctx, "expected sucessfully completed cfg_size command\n");
+		dbg(ctx, "expected successfully completed cfg_size command\n");
 		return NULL;
 	}
 
@@ -3275,7 +3275,7 @@ NDCTL_EXPORT struct ndctl_cmd *ndctl_dimm_cmd_new_cfg_write(struct ndctl_cmd *cf
 	/* enforce rmw */
 	if (cfg_read->type != ND_CMD_GET_CONFIG_DATA
 		       || cfg_read->status != 0) {
-		dbg(ctx, "expected sucessfully completed cfg_read command\n");
+		dbg(ctx, "expected successfully completed cfg_read command\n");
 		return NULL;
 	}
 
diff --git a/test/daxctl-devices.sh b/test/daxctl-devices.sh
index dfce74b..659428d 100755
--- a/test/daxctl-devices.sh
+++ b/test/daxctl-devices.sh
@@ -117,7 +117,7 @@ daxctl_test()
 	if ! "$NDCTL" disable-namespace "$testdev"; then
 		echo "disable-namespace failed as expected"
 	else
-		echo "disable-namespace succeded, expected failure"
+		echo "disable-namespace succeeded, expected failure"
 		echo "reboot required to recover from this state"
 		return 1
 	fi
@@ -130,7 +130,7 @@ daxctl_test()
 	if ! "$DAXCTL" reconfigure-device -N -m system-ram "$daxdev"; then
 		echo "reconfigure failed as expected"
 	else
-		echo "reconfigure succeded, expected failure"
+		echo "reconfigure succeeded, expected failure"
 		restore_online_policy
 		return 1
 	fi
-- 
2.50.1


             reply	other threads:[~2025-08-14 10:35 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-14 10:07 Yi Zhang [this message]
2025-08-14 21:02 ` [ndctl PATCH v3] ndctl: fix user visible spelling errors Alison Schofield

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=20250814100701.2056883-1-yi.zhang@redhat.com \
    --to=yi.zhang@redhat.com \
    --cc=alison.schofield@intel.com \
    --cc=dave.jiang@intel.com \
    --cc=linux-cxl@vger.kernel.org \
    --cc=nvdimm@lists.linux.dev \
    /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;
as well as URLs for NNTP newsgroup(s).