Date: Wed, 7 Sep 2022 07:31:54 GMT From: Gordon Bergling <gbe@FreeBSD.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org Subject: git: be0601da3244 - stable/13 - bhnd(4): Correct some typos in source code comments Message-ID: <202209070731.2877VsQY054409@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch stable/13 has been updated by gbe (doc committer): URL: https://cgit.FreeBSD.org/src/commit/?id=be0601da324410f5b801ac3a432febbcd2b60b16 commit be0601da324410f5b801ac3a432febbcd2b60b16 Author: Gordon Bergling <gbe@FreeBSD.org> AuthorDate: 2022-09-04 10:49:42 +0000 Commit: Gordon Bergling <gbe@FreeBSD.org> CommitDate: 2022-09-07 07:29:32 +0000 bhnd(4): Correct some typos in source code comments - s/occured/occurred/ While here, fix some whitespace issues. (cherry picked from commit 88cdf609e411a1ba398e9e3e93ad82345ad8b516) --- sys/dev/bhnd/bcma/bcma_erom.c | 4 ++-- sys/dev/bhnd/bhnd.h | 2 +- sys/dev/bhnd/bhnd_bus_if.m | 2 +- sys/dev/bhnd/bhnd_erom.c | 4 ++-- sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c | 2 +- sys/dev/bhnd/nvram/bhnd_nvram_io.c | 22 +++++++++++----------- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/sys/dev/bhnd/bcma/bcma_erom.c b/sys/dev/bhnd/bcma/bcma_erom.c index 14a33d5a3ae9..14abc49f147a 100644 --- a/sys/dev/bhnd/bcma/bcma_erom.c +++ b/sys/dev/bhnd/bcma/bcma_erom.c @@ -720,13 +720,13 @@ bcma_erom_seek_matching_core(struct bcma_erom *sc, return (0); } - /* Not found, or a parse error occured */ + /* Not found, or a parse error occurred */ return (error); } /** * Read the next core descriptor from the EROM table. - * + * * @param erom EROM read state. * @param[out] core On success, will be populated with the parsed core * descriptor data. diff --git a/sys/dev/bhnd/bhnd.h b/sys/dev/bhnd/bhnd.h index 3482b4dd174b..6994889f83fd 100644 --- a/sys/dev/bhnd/bhnd.h +++ b/sys/dev/bhnd/bhnd.h @@ -823,7 +823,7 @@ bhnd_read_iost(device_t dev, uint16_t *iost) * @param dev The device to query. * * @retval true If @p dev is held in RESET or not clocked (BHND_IOCTL_CLK_EN), - * or an error occured determining @p dev's hardware state. + * or an error occurred determining @p dev's hardware state. * @retval false If @p dev is clocked and is not held in RESET. */ static inline bool diff --git a/sys/dev/bhnd/bhnd_bus_if.m b/sys/dev/bhnd/bhnd_bus_if.m index 23fa847d9bd9..379898f9af26 100644 --- a/sys/dev/bhnd/bhnd_bus_if.m +++ b/sys/dev/bhnd/bhnd_bus_if.m @@ -616,7 +616,7 @@ METHOD int read_iost { * @param child The device to query. * * @retval true If @p child is held in RESET or not clocked (BHND_IOCTL_CLK_EN), - * or an error occured determining @p child's hardware state. + * or an error occurred determining @p child's hardware state. * @retval false If @p child is clocked and is not held in RESET. */ METHOD bool is_hw_suspended { diff --git a/sys/dev/bhnd/bhnd_erom.c b/sys/dev/bhnd/bhnd_erom.c index 44d741276eaf..d45e3efe88ac 100644 --- a/sys/dev/bhnd/bhnd_erom.c +++ b/sys/dev/bhnd/bhnd_erom.c @@ -159,7 +159,7 @@ bhnd_erom_probe_driver_classes(devclass_t bus_devclass, /** * Allocate and return a new device enumeration table parser. - * + * * @param cls The parser class for which an instance will be * allocated. * @param eio The bus I/O callbacks to use when reading the device @@ -167,7 +167,7 @@ bhnd_erom_probe_driver_classes(devclass_t bus_devclass, * @param cid The device's chip identifier. * * @retval non-NULL success - * @retval NULL if an error occured allocating or initializing the + * @retval NULL if an error occurred allocating or initializing the * EROM parser. */ bhnd_erom_t * diff --git a/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c b/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c index 46ce66d4f434..a0b1e120a0b1 100644 --- a/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c +++ b/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c @@ -359,7 +359,7 @@ bhnd_nvram_sprom_getvar_direct(struct bhnd_nvram_io *io, const char *name, if (error == ENOENT) return (ENOENT); - /* Some other parse error occured */ + /* Some other parse error occurred */ return (error); } diff --git a/sys/dev/bhnd/nvram/bhnd_nvram_io.c b/sys/dev/bhnd/nvram/bhnd_nvram_io.c index 5af048906bfb..d04fe75adbcc 100644 --- a/sys/dev/bhnd/nvram/bhnd_nvram_io.c +++ b/sys/dev/bhnd/nvram/bhnd_nvram_io.c @@ -41,9 +41,9 @@ __FBSDID("$FreeBSD$"); #include "bhnd_nvram_io.h" #include "bhnd_nvram_iovar.h" -/** +/** * Read exactly @p nbytes from @p io at @p offset. - * + * * @param io NVRAM I/O context. * @param offset The offset within @p io at which to perform the read. * @param[out] buffer Output buffer to which @p nbytes from @p io will be @@ -51,7 +51,7 @@ __FBSDID("$FreeBSD$"); * @param nbytes The maximum number of bytes to be read from @p io. * * @retval 0 success - * @retval EIO if an input error occured reading @p io. + * @retval EIO if an input error occurred reading @p io. * @retval ENXIO if the request for @p offset or @p nbytes exceeds the size * of @p io. * @retval EFAULT if @p io requires I/O request alignment and @p offset is @@ -69,11 +69,11 @@ bhnd_nvram_io_read(struct bhnd_nvram_io *io, size_t offset, void *buffer, /** * Attempt to fetch a pointer to @p io's internal read buffer, if * supported by @p io. - * + * * The returned pointer is only gauranteed to be valid until the next I/O * operation performed on @p io; concrete implementations of bhnd_nvram_io * may provide stronger gaurantees. - * + * * @param io NVRAM I/O context. * @param offset The offset within @p io for which to return a buffer pointer. * @param[out] ptr On success, will be initialized with a pointer to @p io's @@ -82,10 +82,10 @@ bhnd_nvram_io_read(struct bhnd_nvram_io *io, size_t offset, void *buffer, * @param[out] navail The actual number of readable bytes, which may be greater * than @p nbytes. If this value is not required, a NULL pointer may be * provided. - * + * * @retval 0 success - * @retval EIO if an input error occured reading @p io. - * @retval ENODEV if @p io does not support direct access to its backing read + * @retval EIO if an input error occurred reading @p io. + * @retval ENODEV if @p io does not support direct access to its backing read * buffer. * @retval ENXIO if the request exceeds the size of @p io. * @retval EFAULT if @p io requires I/O request alignment and @p offset or @@ -98,9 +98,9 @@ bhnd_nvram_io_read_ptr(struct bhnd_nvram_io *io, size_t offset, return (io->iops->read_ptr(io, offset, ptr, nbytes, navail)); } -/** +/** * Write @p nbytes to @p io at @p offset. - * + * * @param io NVRAM I/O context. * @param offset The offset within @p io at which to perform the write. * @param buffer Data to be written to @p io. @@ -193,7 +193,7 @@ bhnd_nvram_io_setsize(struct bhnd_nvram_io *io, size_t size) /** * Free a previously allocated I/O context, releasing all associated * resources. - * + * * @param io The I/O context to be freed. */ void
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202209070731.2877VsQY054409>