tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

scsi: lpfc: ELIMINATE kernel-doc warnings in lpfc.h

Avoid all kernel-doc warnings in lpfc.h:

- Use the correct function parameter name

- Add a '*' to a kernel-doc line

- Repair the function Returns: comments

Fixes these warnings:

Warning: drivers/scsi/lpfc/lpfc.h:1674 No description found for return
value of 'lpfc_next_online_cpu'
Warning: drivers/scsi/lpfc/lpfc.h:1686 No description found for return
value of 'lpfc_next_present_cpu'
Warning: drivers/scsi/lpfc/lpfc.h:1700 function parameter 'eq' not
described in 'lpfc_sli4_mod_hba_eq_delay'
Warning: drivers/scsi/lpfc/lpfc.h:1755 bad line: --------------------------
Warning: drivers/scsi/lpfc/lpfc.h:1759 No description found for return
value of 'lpfc_is_vmid_enabled'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Justin Tee <justin.tee@broadcom.com>
Link: https://patch.msgid.link/20260224234954.3606638-1-rdunlap@infradead.org
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

authored by

Randy Dunlap and committed by
Martin K. Petersen 5e0d4fdb e521b776

+7 -4
+7 -4
drivers/scsi/lpfc/lpfc.h
··· 1667 1667 * @mask: Pointer to phba's cpumask member. 1668 1668 * @start: starting cpu index 1669 1669 * 1670 - * Note: If no valid cpu found, then nr_cpu_ids is returned. 1670 + * Returns: next online CPU in @mask on success 1671 1671 * 1672 + * Note: If no valid cpu found, then nr_cpu_ids is returned. 1672 1673 **/ 1673 1674 static __always_inline unsigned int 1674 1675 lpfc_next_online_cpu(const struct cpumask *mask, unsigned int start) ··· 1681 1680 * lpfc_next_present_cpu - Finds next present CPU after n 1682 1681 * @n: the cpu prior to search 1683 1682 * 1684 - * Note: If no next present cpu, then fallback to first present cpu. 1683 + * Returns: next present CPU after CPU @n 1685 1684 * 1685 + * Note: If no next present cpu, then fallback to first present cpu. 1686 1686 **/ 1687 1687 static __always_inline unsigned int lpfc_next_present_cpu(int n) 1688 1688 { ··· 1693 1691 /** 1694 1692 * lpfc_sli4_mod_hba_eq_delay - update EQ delay 1695 1693 * @phba: Pointer to HBA context object. 1696 - * @q: The Event Queue to update. 1694 + * @eq: The Event Queue to update. 1697 1695 * @delay: The delay value (in us) to be written. 1698 1696 * 1699 1697 **/ ··· 1755 1753 * Pr Tag 1 0 N 1756 1754 * Pr Tag 1 1 Y 1757 1755 * Pr Tag 2 * Y 1758 - --------------------------------------------------- 1756 + * --------------------------------------------------- 1759 1757 * 1758 + * Returns: whether VMID is enabled 1760 1759 **/ 1761 1760 static inline int lpfc_is_vmid_enabled(struct lpfc_hba *phba) 1762 1761 {