Skip to contentSkip to conversation

Fix kernel-doc for amdgpu_display_manager

PATCH In review Kenner de Azevedo dos Santos Miranda 2 participants 3 messages Apr 30 – May 26

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Fix kernel-doc for amdgpu_display_manager

The struct boot_time_crc_info is not described in amdgpu_display_manager.

Running the make htmldocs is showing the following warning :

WARNING: ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 struct member 'boot_time_crc_info' not described in 'amdgpu_display_manager'

i added the description that fix the warning and describe the struct.

The warning is not showing anymore in make htmldocs after change.

---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 1 +
 1 file changed, 1 insertion(+)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +1 -0
index 74a8fe1a1999..201b4796b591 100644
@@ -347,6 +347,7 @@ struct hpd_rx_irq_offload_work {
  * @dmub_aux_transfer_done: struct completion used to indicate when DMUB
  * 			    transfers are done
  * @delayed_hpd_wq: work queue used to delay DMUB HPD work
+ * @boot_time_crc_info: Stores CRC information collected during boot
  */
 struct amdgpu_display_manager {
 
Signature · 1 line
2.43.0
#1 lore raw

Hi Team, good afternoon.

Any update about this patch?

Regards,

Kenner Azevedo

Quoted 31 lines · Kenner de Azevedo dos Santos Miranda

The struct boot_time_crc_info is not described in amdgpu_display_manager.

Running the make htmldocs is showing the following warning :

WARNING: ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 struct member 'boot_time_crc_info' not described in 'amdgpu_display_manager'

i added the description that fix the warning and describe the struct.

The warning is not showing anymore in make htmldocs after change.

---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 1 +
 1 file changed, 1 insertion(+)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +1 -1
index 74a8fe1a1999..201b4796b591 100644
@@ -347,6 +347,7 @@ struct hpd_rx_irq_offload_work {
  * @dmub_aux_transfer_done: struct completion used to indicate when DMUB
  *                         transfers are done
  * @delayed_hpd_wq: work queue used to delay DMUB HPD work
+ * @boot_time_crc_info: Stores CRC information collected during boot
  */
 struct amdgpu_display_manager {
 
--

2.43.0

#2 lore raw
In reply to Kenner de Azevedo dos Santos Miranda
Quoted 21 lines · Kenner de Azevedo dos Santos Miranda

The struct boot_time_crc_info is not described in amdgpu_display_manager.

Running the make htmldocs is showing the following warning :

WARNING: ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 struct member 'boot_time_crc_info' not described in 'amdgpu_display_manager'

i added the description that fix the warning and describe the struct.

The warning is not showing anymore in make htmldocs after change.

---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 1 +
 1 file changed, 1 insertion(+)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +0 -0
index 74a8fe1a1999..201b4796b591 100644

drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h struct hpd_rx_irq_offload_work { · line 350

Quoted 4 lines
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +1 -0
@@ -347,6 +347,7 @@ struct hpd_rx_irq_offload_work {
  * @dmub_aux_transfer_done: struct completion used to indicate when DMUB
  *                         transfers are done
  * @delayed_hpd_wq: work queue used to delay DMUB HPD work
+ * @boot_time_crc_info: Stores CRC information collected during boot

This element has kerneldoc within the structure already:

    /**
         * @dm_boot_time_crc_info:
         *
         * Buffer info for the boot time crc.
         */
        struct dm_boot_time_crc_info boot_time_crc_info;

Alex

Quoted 6 lines
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +0 -1
  */
 struct amdgpu_display_manager {
 
--

2.43.0