[ndctl PATCH v2 0/2] Fix some typos

[ndctl PATCH v2 0/2] Fix some typos

[Fan Ni]

Fix typos found in libcxl code and documentation. The first is separate as
it deals with an ABI, while the second patch fixes the remaining documentation.

Changes from v1[1]:
- Removed export of cxl_memdev_get_firmware_version and instead
	implement it as an inline function in cxl/libcxl.h. (Dan)
- Reverted the changes to the cxl/lib/libcxl.sym. (Dan)
- Removed cxl_memdev_get_firmware_verison from
	Documentation/cxl/lib/libcxl.txt. (David)
- Fix typos in Documentation/cxl/lib/libcxl.txt. (David)

[1]: v1:
https://lore.kernel.org/linux-cxl/20221101154628.GB78088@bgt-140510-bm03/T/#t

Fan Ni (2):
  libcxl: Add cxl_memdev_get_firmware_version
  libcxl: Fix typos

 Documentation/cxl/lib/libcxl.txt | 6 +++---
 cxl/libcxl.h                     | 8 ++++++++
 2 files changed, 11 insertions(+), 3 deletions(-)

-- 
2.25.1

[PATCH 1/2] libcxl: Add cxl_memdev_get_firmware_version

[Fan Ni]

cxl_memdev_get_firmware_verison is a typo and part of the ABI.
Avoid breakage by introducing a stub with the correct name and update
the documentation accordingly.

Reviewed-by: Davidlohr Bueso <dave@stgolabs.net>
Signed-off-by: Fan Ni <fan.ni@samsung.com>
---
 Documentation/cxl/lib/libcxl.txt | 2 +-
 cxl/libcxl.h                     | 8 ++++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/Documentation/cxl/lib/libcxl.txt b/Documentation/cxl/lib/libcxl.txt
index fd2962a..edc852d 100644
--- a/Documentation/cxl/lib/libcxl.txt
+++ b/Documentation/cxl/lib/libcxl.txt
@@ -68,7 +68,7 @@ int cxl_memdev_get_major(struct cxl_memdev *memdev);
 int cxl_memdev_get_minor(struct cxl_memdev *memdev);
 unsigned long long cxl_memdev_get_pmem_size(struct cxl_memdev *memdev);
 unsigned long long cxl_memdev_get_ram_size(struct cxl_memdev *memdev);
-const char *cxl_memdev_get_firmware_verison(struct cxl_memdev *memdev);
+const char *cxl_memdev_get_firmware_version(struct cxl_memdev *memdev);
 size_t cxl_memdev_get_label_size(struct cxl_memdev *memdev);
 int cxl_memdev_nvdimm_bridge_active(struct cxl_memdev *memdev);
 int cxl_memdev_get_numa_node(struct cxl_memdev *memdev);
diff --git a/cxl/libcxl.h b/cxl/libcxl.h
index 9fe4e99..d097026 100644
--- a/cxl/libcxl.h
+++ b/cxl/libcxl.h
@@ -48,6 +48,14 @@ struct cxl_ctx *cxl_memdev_get_ctx(struct cxl_memdev *memdev);
 unsigned long long cxl_memdev_get_pmem_size(struct cxl_memdev *memdev);
 unsigned long long cxl_memdev_get_ram_size(struct cxl_memdev *memdev);
 const char *cxl_memdev_get_firmware_verison(struct cxl_memdev *memdev);
+
+/* ABI spelling mistakes are forever */
+static inline const char *cxl_memdev_get_firmware_version(
+		struct cxl_memdev *memdev)
+{
+	return cxl_memdev_get_firmware_verison(memdev);
+}
+
 size_t cxl_memdev_get_label_size(struct cxl_memdev *memdev);
 int cxl_memdev_disable_invalidate(struct cxl_memdev *memdev);
 int cxl_memdev_enable(struct cxl_memdev *memdev);
-- 
2.25.1

[PATCH 2/2] libcxl: Fix typos

[Fan Ni]

Fix typos caught by Davidhohr Bueso in Documentation/cxl/lib/libcxl.txt.

Reviewed-by: Davidlohr Bueso <dave@stgolabs.net>
Signed-off-by: Fan Ni <fan.ni@samsung.com>
---
 Documentation/cxl/lib/libcxl.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/cxl/lib/libcxl.txt b/Documentation/cxl/lib/libcxl.txt
index edc852d..7404efa 100644
--- a/Documentation/cxl/lib/libcxl.txt
+++ b/Documentation/cxl/lib/libcxl.txt
@@ -110,7 +110,7 @@ may appear in the topology that were not previously enumerable.
 
 NOTE: cxl_memdev_disable_invalidate() will force disable the memdev
 regardless of whether the memory provided by the device is in active use
-by the operating system. Callers take responisbility for assuring that
+by the operating system. Callers take responsibility for assuring that
 it is safe to disable the memory device. Otherwise, this call can be as
 destructive as ripping a DIMM out of a running system. Like all other
 libcxl calls that mutate the system state or divulge security sensitive
@@ -327,7 +327,7 @@ const char *cxl_dport_get_physical_node(struct cxl_dport *dport);
 int cxl_dport_get_id(struct cxl_dport *dport);
 bool cxl_dport_maps_memdev(struct cxl_dport *dport, struct cxl_memdev *memdev);
 ----
-The id of a dport is the hardware idenfifier used by an upstream port to
+The id of a dport is the hardware identifier used by an upstream port to
 reference a downstream port. The physical node of a dport is only
 available for platform firmware defined downstream ports and alias the
 companion object, like a PCI host bridge, in the PCI device hierarchy.
-- 
2.25.1