From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bin Meng Date: Thu, 3 Oct 2019 16:29:48 +0800 Subject: [U-Boot] [PATCH v2 19/38] x86: fsp: Tidy up comment style a little In-Reply-To: References: <20190925141147.191166-1-sjg@chromium.org> <20190925141147.191166-20-sjg@chromium.org> Message-ID: List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: u-boot@lists.denx.de On Wed, Oct 2, 2019 at 10:06 PM Bin Meng wrote: > > Hi Simon, > > On Wed, Sep 25, 2019 at 10:12 PM Simon Glass wrote: > > > > The comments in the FSP code use a different style from the rest of the > > x86 code. I am not sure it this is intentional. > > I guess it's because when it was written I was not familiar with the > documenting style :) > > > > > Signed-off-by: Simon Glass > > --- > > > > Changes in v2: None > > > > arch/x86/include/asm/fsp/fsp_support.h | 42 ++++++++++++------------- > > arch/x86/include/asm/fsp1/fsp_support.h | 30 ++++++++++++------ > > arch/x86/include/asm/hob.h | 18 +++++------ > > arch/x86/lib/hob.c | 8 ++--- > > 4 files changed, 54 insertions(+), 44 deletions(-) > > > > [snip] > > > diff --git a/arch/x86/include/asm/hob.h b/arch/x86/include/asm/hob.h > > index b4239821aaa..72151ea045e 100644 > > --- a/arch/x86/include/asm/hob.h > > +++ b/arch/x86/include/asm/hob.h > > @@ -135,7 +135,7 @@ struct hob_guid { > > * > > * @hdr: A pointer to a HOB. > > * > > - * @return: A pointer to the next HOB in the HOB list. > > + * @return A pointer to the next HOB in the HOB list. > > */ > > static inline const struct hob_header *get_next_hob(const struct hob_header > > *hdr) > > @@ -152,8 +152,8 @@ static inline const struct hob_header *get_next_hob(const struct hob_header > > * > > * @hdr: A pointer to a HOB. > > * > > - * @retval true: The HOB specified by hdr is the last HOB in the HOB list. > > - * @retval false: The HOB specified by hdr is not the last HOB in the HOB list. > > + * @return true: The HOB specified by hdr is the last HOB in the HOB list. > > + * @return false: The HOB specified by hdr is not the last HOB in the HOB list. > > */ > > static inline bool end_of_hob(const struct hob_header *hdr) > > { > > @@ -169,7 +169,7 @@ static inline bool end_of_hob(const struct hob_header *hdr) > > * > > * @hdr: A pointer to a HOB. > > * > > - * @return: A pointer to the data buffer in a HOB. > > + * @return A pointer to the data buffer in a HOB. > > */ > > static inline void *get_guid_hob_data(const struct hob_header *hdr) > > { > > @@ -185,7 +185,7 @@ static inline void *get_guid_hob_data(const struct hob_header *hdr) > > * > > * @hdr: A pointer to a HOB. > > * > > - * @return: The size of the data buffer. > > + * @return The size of the data buffer. > > */ > > static inline u16 get_guid_hob_data_size(const struct hob_header *hdr) > > { > > @@ -198,7 +198,7 @@ static inline u16 get_guid_hob_data_size(const struct hob_header *hdr) > > * @type: HOB type to search > > * @hob_list: A pointer to the HOB list > > * > > - * @retval: A HOB object with matching type; Otherwise NULL. > > + *@return A HOB object with matching type; Otherwise NULL. > > should have a space between * and @ > > > */ > > const struct hob_header *hob_get_next_hob(uint type, const void *hob_list); > > > > @@ -208,7 +208,7 @@ const struct hob_header *hob_get_next_hob(uint type, const void *hob_list); > > * @guid: GUID to search > > * @hob_list: A pointer to the HOB list > > * > > - * @retval: A HOB object with matching GUID; Otherwise NULL. > > + *@return A HOB object with matching GUID; Otherwise NULL. > > should have a space between * and @ > > > */ > > const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, > > const void *hob_list); > > @@ -221,8 +221,8 @@ const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, > > * If the GUID HOB is located, the length will be updated. > > * @guid A pointer to HOB GUID. > > * > > - * @retval NULL: Failed to find the GUID HOB. > > - * @retval others: GUID HOB data buffer pointer. > > + * @return NULL: Failed to find the GUID HOB. > > + * @return others: GUID HOB data buffer pointer. > > */ > > void *hob_get_guid_hob_data(const void *hob_list, u32 *len, > > const efi_guid_t *guid); > > diff --git a/arch/x86/lib/hob.c b/arch/x86/lib/hob.c > > index dcee29b04cf..f2c47240ee8 100644 > > --- a/arch/x86/lib/hob.c > > +++ b/arch/x86/lib/hob.c > > @@ -13,7 +13,7 @@ > > * @type: HOB type to search > > * @hob_list: A pointer to the HOB list > > * > > - * @retval: A HOB object with matching type; Otherwise NULL. > > + * @return A HOB object with matching type; Otherwise NULL. > > */ > > const struct hob_header *hob_get_next_hob(uint type, const void *hob_list) > > { > > @@ -38,7 +38,7 @@ const struct hob_header *hob_get_next_hob(uint type, const void *hob_list) > > * @guid: GUID to search > > * @hob_list: A pointer to the HOB list > > * > > - * @retval: A HOB object with matching GUID; Otherwise NULL. > > + * @return A HOB object with matching GUID; Otherwise NULL. > > */ > > const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, > > const void *hob_list) > > @@ -65,8 +65,8 @@ const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, > > * If the GUID HOB is located, the length will be updated. > > * @guid A pointer to HOB GUID. > > * > > - * @retval NULL: Failed to find the GUID HOB. > > - * @retval others: GUID HOB data buffer pointer. > > + * @return NULL: Failed to find the GUID HOB. > > + * @return others: GUID HOB data buffer pointer. > > */ > > void *hob_get_guid_hob_data(const void *hob_list, u32 *len, > > const efi_guid_t *guid) > > -- > > Other than above, > Fixed the 2 comment style issues above, and resolved the rebase conflicts, and > Reviewed-by: Bin Meng applied to u-boot-x86/next, thanks!