Re: [PATCH] mhi: fix doubled words and struct image_info kernel-doc

From: Manivannan Sadhasivam
Date: Wed Jul 15 2020 - 23:11:32 EST


On Wed, Jul 15, 2020 at 06:29:32PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Drop doubled word "table" in kernel-doc.
> Fix syntax for the kernel-doc notation for struct image_info.
> Note that the bhi_vec field is private and not part of the kernel-doc.
>
> Drop doubled word "device" in a comment.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Applied to mhi-next!

Thanks,
Mani

> Cc: Manivannan Sadhasivam <manivannan.sadhasivam@xxxxxxxxxx>
> Cc: Hemant Kumar <hemantk@xxxxxxxxxxxxxx>
> Cc: linux-arm-msm@xxxxxxxxxxxxxxx
> ---
> include/linux/mhi.h | 10 ++++++----
> 1 file changed, 6 insertions(+), 4 deletions(-)
>
> --- linux-next-20200714.orig/include/linux/mhi.h
> +++ linux-next-20200714/include/linux/mhi.h
> @@ -85,13 +85,15 @@ enum mhi_ch_type {
> };
>
> /**
> - * struct image_info - Firmware and RDDM table table
> - * @mhi_buf - Buffer for firmware and RDDM table
> - * @entries - # of entries in table
> + * struct image_info - Firmware and RDDM table
> + * @mhi_buf: Buffer for firmware and RDDM table
> + * @entries: # of entries in table
> */
> struct image_info {
> struct mhi_buf *mhi_buf;
> + /* private: from internal.h */
> struct bhi_vec_entry *bhi_vec;
> + /* public: */
> u32 entries;
> };
>
> @@ -593,7 +595,7 @@ int mhi_async_power_up(struct mhi_contro
>
> /**
> * mhi_sync_power_up - Start MHI power up sequence and wait till the device
> - * device enters valid EE state
> + * enters valid EE state
> * @mhi_cntrl: MHI controller
> */
> int mhi_sync_power_up(struct mhi_controller *mhi_cntrl);
>