Skip to contentSkip to conversation

lib/igt_kms: Fix docbook warnings

PATCH In review Maarten Lankhorst 3 participants 5 messages Feb 21, 2018 – Feb 27, 2018 Library code

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 lib/igt_kms: Fix docbook warnings

This gets rid of the following warnings:
lib/igt_kms.c:2688: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2738: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2788: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2812: warning: Parameter description for igt_pipe_obj_replace_prop_blob::pipe is not used from source code comment block. lib/igt_kms.c:2812: warning: Parameter description for igt_pipe_obj_replace_prop_blob::pipe_obj is missing in source code comment block. lib/igt_kms.c:3794: warning: Parameter description for igt_cleanup_hotplug::mon is missing in source code comment block.

---
 lib/igt_kms.c | 20 ++++++++++++--------
 lib/igt_kms.h |  2 +-
 2 files changed, 13 insertions(+), 9 deletions(-)
lib/igt_kms.c +12 -8
index e14ecf3b155d..8c10eb5b67e9 100644
@@ -361,9 +361,9 @@ int kmstest_pipe_to_index(char pipe)
 
 /**
  * kmstest_plane_type_name:
- * @plane: display plane
+ * @plane_type: display plane type
  *
- * Returns: String representing @plane, e.g. "overlay".
+ * Returns: String representing @plane_type, e.g. "overlay".
  */
 const char *kmstest_plane_type_name(int plane_type)
 {
@@ -2677,11 +2677,12 @@ static uint64_t igt_mode_object_get_prop(igt_display_t *display,
 }
 
 /**
- * igt_plane_get_prop - Return current value on a plane for a given property.
- *
+ * igt_plane_get_prop:
  * @plane: Target plane.
  * @prop: Property to check.
  *
+ * Return current value on a plane for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -2727,11 +2728,12 @@ igt_plane_replace_prop_blob(igt_plane_t *plane, enum igt_atomic_plane_properties
 }
 
 /**
- * igt_output_get_prop - Return current value on an output for a given property.
- *
+ * igt_output_get_prop:
  * @output: Target output.
  * @prop: Property to return.
  *
+ * Return current value on an output for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -2777,11 +2779,12 @@ igt_output_replace_prop_blob(igt_output_t *output, enum igt_atomic_connector_pro
 }
 
 /**
- * igt_pipe_obj_get_prop - Return current value on a pipe for a given property.
- *
+ * igt_pipe_obj_get_prop:
  * @pipe: Target pipe.
  * @prop: Property to return.
  *
+ * Return current value on a pipe for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -3789,6 +3792,7 @@ void igt_flush_hotplugs(struct udev_monitor *mon)
 
 /**
  * igt_cleanup_hotplug:
+ * @mon: A udev monitor initialized with #igt_watch_hotplug
  *
  * Cleanup the resources allocated by #igt_watch_hotplug
  */
lib/igt_kms.h +1 -1
index b75210393d3b..94e4619b4dd0 100644
@@ -640,7 +640,7 @@ igt_pipe_has_prop(igt_display_t *display, enum pipe pipe,
 #define igt_pipe_set_prop_value(display, pipe, prop, value) \
 	igt_pipe_obj_set_prop_value(&(display)->pipes[(pipe)], prop, value)
 
-extern void igt_pipe_obj_replace_prop_blob(igt_pipe_t *pipe_obj,
+extern void igt_pipe_obj_replace_prop_blob(igt_pipe_t *pipe,
 					   enum igt_atomic_crtc_properties prop,
 					   const void *ptr, size_t length);
 
Signature · 6 lines
2.16.1

_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev
#1 lore raw

PATCH 2/2 lib/igt_kms: Remove remaining docbook warnings mentioning igt_kms files.

Some warnings still exist, but they are about missing descriptions for structs enums and their members.

---
 lib/igt_kms.h | 29 ++++++++++++++++++-----------
 1 file changed, 18 insertions(+), 11 deletions(-)
lib/igt_kms.h +18 -11
index 94e4619b4dd0..eb147152128a 100644
@@ -47,7 +47,9 @@
  * @PIPE_A: First crtc.
  * @PIPE_B: Second crtc.
  * @PIPE_C: Third crtc.
- * ... and so on.
+ * @PIPE_D: Fourth crtc.
+ * @PIPE_E: Fifth crtc.
+ * @PIPE_F: Sixth crtc.
  * @IGT_MAX_PIPES: Max number of pipes allowed.
  */
 enum pipe {
@@ -495,11 +497,12 @@ static inline bool igt_output_is_connected(igt_output_t *output)
 #define IGT_FIXED(i,f)	((i) << 16 | (f))
 
 /**
- * igt_plane_has_prop - Check whether plane supports a given property.
- *
+ * igt_plane_has_prop:
  * @plane: Plane to check.
  * @prop: Property to check.
  *
+ * Check whether plane supports a given property.
+ *
  * Returns: True if the property is supported, otherwise false.
  */
 static inline bool
@@ -530,11 +533,12 @@ extern void igt_plane_replace_prop_blob(igt_plane_t *plane,
 					const void *ptr, size_t length);
 
 /**
- * igt_output_has_prop - Check whether output supports a given property.
- *
+ * igt_output_has_prop:
  * @output: Output to check.
  * @prop: Property to check.
  *
+ * Check whether output supports a given property.
+ *
  * Returns: True if the property is supported, otherwise false.
  */
 static inline bool
@@ -564,11 +568,12 @@ extern void igt_output_replace_prop_blob(igt_output_t *output,
 					 const void *ptr, size_t length);
 
 /**
- * igt_pipe_obj_has_prop - Check whether pipe supports a given property.
- *
+ * igt_pipe_obj_has_prop:
  * @pipe: Pipe to check.
  * @prop: Property to check.
  *
+ * Check whether pipe supports a given property.
+ *
  * Returns: True if the property is supported, otherwise false.
  */
 static inline bool
@@ -580,12 +585,13 @@ igt_pipe_obj_has_prop(igt_pipe_t *pipe, enum igt_atomic_crtc_properties prop)
 uint64_t igt_pipe_obj_get_prop(igt_pipe_t *pipe, enum igt_atomic_crtc_properties prop);
 
 /**
- * igt_pipe_get_prop - Return current value on a pipe for a given property.
- *
+ * igt_pipe_get_prop:
  * @display: Pointer to display.
  * @pipe: Target pipe.
  * @prop: Property to return.
  *
+ * Return current value on a pipe for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -598,12 +604,13 @@ igt_pipe_get_prop(igt_display_t *display, enum pipe pipe,
 }
 
 /**
- * igt_pipe_has_prop - Check whether pipe supports a given property.
- *
+ * igt_pipe_has_prop:
  * @display: Pointer to display.
  * @pipe: Pipe to check.
  * @prop: Property to check.
  *
+ * Check whether pipe supports a given property.
+ *
  * Returns: True if the property is supported, otherwise false.
  */
 static inline bool
Signature · 6 lines
2.16.1

_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev
#2 lore raw

[igt-dev] ✓ Fi.CI.BAT: success for series starting with [i-g-t,1/2] lib/igt_kms: Fix docbook warnings

In reply to Maarten Lankhorst
== Series Details ==

== Series Details ==

Series: series starting with [i-g-t,1/2] lib/igt_kms: Fix docbook warnings
URL : https://patchwork.freedesktop.org/series/38682/
State : success

== Summary ==

IGT patchset tested on top of latest successful build 960e55a87d7b7d7385063e37cc9f281df2be8037 igt/gem_ctx_isolation: Check isolation of registers between contexts

with latest DRM-Tip kernel build CI_DRM_3816
42d073db2a85 drm-tip: 2018y-02m-21d-14h-03m-58s UTC integration manifest

No testlist changes.

Test debugfs_test:

        Subgroup read_all_entries:
                pass       -> INCOMPLETE (fi-snb-2520m) fdo#103713
Test gem_mmap_gtt:
        Subgroup basic-small-bo-tiledx:
                pass       -> FAIL       (fi-gdg-551) fdo#102575
Test kms_pipe_crc_basic:
        Subgroup suspend-read-crc-pipe-a:
                fail       -> PASS       (fi-ivb-3520m)
        Subgroup suspend-read-crc-pipe-b:
                fail       -> PASS       (fi-ivb-3520m)
        Subgroup suspend-read-crc-pipe-c:
                fail       -> PASS       (fi-ivb-3520m)

fdo#103713 https://bugs.freedesktop.org/show_bug.cgi?id=103713
fdo#102575 https://bugs.freedesktop.org/show_bug.cgi?id=102575

fi-bdw-5557u     total:288  pass:267  dwarn:0   dfail:0   fail:0   skip:21  time:419s
fi-bdw-gvtdvm    total:288  pass:264  dwarn:0   dfail:0   fail:0   skip:24  time:434s
fi-blb-e6850     total:288  pass:223  dwarn:1   dfail:0   fail:0   skip:64  time:375s
fi-bsw-n3050     total:288  pass:242  dwarn:0   dfail:0   fail:0   skip:46  time:494s
fi-bwr-2160      total:288  pass:183  dwarn:0   dfail:0   fail:0   skip:105 time:286s
fi-bxt-dsi       total:288  pass:258  dwarn:0   dfail:0   fail:0   skip:30  time:480s
fi-bxt-j4205     total:288  pass:259  dwarn:0   dfail:0   fail:0   skip:29  time:480s
fi-byt-j1900     total:288  pass:253  dwarn:0   dfail:0   fail:0   skip:35  time:467s
fi-byt-n2820     total:288  pass:249  dwarn:0   dfail:0   fail:0   skip:39  time:455s
fi-cfl-s2        total:288  pass:262  dwarn:0   dfail:0   fail:0   skip:26  time:581s
fi-elk-e7500     total:288  pass:229  dwarn:0   dfail:0   fail:0   skip:59  time:418s
fi-gdg-551       total:288  pass:179  dwarn:0   dfail:0   fail:1   skip:108 time:286s
fi-glk-1         total:288  pass:260  dwarn:0   dfail:0   fail:0   skip:28  time:506s
fi-hsw-4770      total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:387s
fi-ilk-650       total:288  pass:228  dwarn:0   dfail:0   fail:0   skip:60  time:413s
fi-ivb-3520m     total:288  pass:259  dwarn:0   dfail:0   fail:0   skip:29  time:455s
fi-ivb-3770      total:288  pass:255  dwarn:0   dfail:0   fail:0   skip:33  time:414s
fi-kbl-7500u     total:288  pass:263  dwarn:1   dfail:0   fail:0   skip:24  time:451s
fi-kbl-7560u     total:288  pass:269  dwarn:0   dfail:0   fail:0   skip:19  time:491s
fi-kbl-7567u     total:288  pass:268  dwarn:0   dfail:0   fail:0   skip:20  time:451s
fi-kbl-r         total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:496s
fi-pnv-d510      total:288  pass:222  dwarn:1   dfail:0   fail:0   skip:65  time:588s
fi-skl-6260u     total:288  pass:268  dwarn:0   dfail:0   fail:0   skip:20  time:428s
fi-skl-6600u     total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:504s
fi-skl-6700hq    total:288  pass:262  dwarn:0   dfail:0   fail:0   skip:26  time:522s
fi-skl-6700k2    total:288  pass:264  dwarn:0   dfail:0   fail:0   skip:24  time:491s
fi-skl-6770hq    total:288  pass:268  dwarn:0   dfail:0   fail:0   skip:20  time:485s
fi-skl-guc       total:288  pass:260  dwarn:0   dfail:0   fail:0   skip:28  time:409s
fi-skl-gvtdvm    total:288  pass:265  dwarn:0   dfail:0   fail:0   skip:23  time:433s
fi-snb-2520m     total:3    pass:2    dwarn:0   dfail:0   fail:0   skip:0  
fi-snb-2600      total:288  pass:248  dwarn:0   dfail:0   fail:0   skip:40  time:401s

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_968/issues.html
_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev

#3 lore raw

[igt-dev] ✓ Fi.CI.IGT: success for series starting with [i-g-t,1/2] lib/igt_kms: Fix docbook warnings

In reply to Maarten Lankhorst
== Series Details ==

== Series Details ==

Series: series starting with [i-g-t,1/2] lib/igt_kms: Fix docbook warnings
URL : https://patchwork.freedesktop.org/series/38682/
State : success

== Summary ==

Test kms_setmode:

        Subgroup basic:
                fail       -> PASS       (shard-hsw) fdo#99912
Test kms_flip:
        Subgroup modeset-vs-vblank-race:
                pass       -> FAIL       (shard-hsw) fdo#103060 +1
        Subgroup 2x-plain-flip-ts-check-interruptible:
                pass       -> FAIL       (shard-hsw) fdo#100368 +2
Test kms_atomic_transition:
        Subgroup 1x-modeset-transitions-nonblocking-fencing:
                fail       -> PASS       (shard-apl) fdo#103207
Test kms_rotation_crc:
        Subgroup sprite-rotation-180:
                fail       -> PASS       (shard-snb) fdo#103925
Test kms_vblank:
        Subgroup pipe-b-wait-busy-hang:
                skip       -> PASS       (shard-snb)
Test perf:
        Subgroup oa-exponents:
                pass       -> INCOMPLETE (shard-apl) fdo#102254
        Subgroup blocking:
                pass       -> FAIL       (shard-hsw) fdo#102252 +1
Test kms_plane_multiple:
        Subgroup legacy-pipe-b-tiling-none:
                skip       -> PASS       (shard-snb)
Test gem_eio:
        Subgroup in-flight:
                incomplete -> PASS       (shard-apl)
Test kms_pipe_crc_basic:
        Subgroup read-crc-pipe-c-frame-sequence:
                fail       -> PASS       (shard-apl) fdo#103481

fdo#99912 https://bugs.freedesktop.org/show_bug.cgi?id=99912
fdo#103060 https://bugs.freedesktop.org/show_bug.cgi?id=103060
fdo#100368 https://bugs.freedesktop.org/show_bug.cgi?id=100368
fdo#103207 https://bugs.freedesktop.org/show_bug.cgi?id=103207
fdo#103925 https://bugs.freedesktop.org/show_bug.cgi?id=103925
fdo#102254 https://bugs.freedesktop.org/show_bug.cgi?id=102254
fdo#102252 https://bugs.freedesktop.org/show_bug.cgi?id=102252
fdo#103481 https://bugs.freedesktop.org/show_bug.cgi?id=103481

shard-apl        total:3320 pass:1742 dwarn:1   dfail:0   fail:12  skip:1563 time:11828s
shard-hsw        total:3465 pass:1765 dwarn:1   dfail:0   fail:5   skip:1693 time:11690s
shard-snb        total:3465 pass:1358 dwarn:1   dfail:0   fail:2   skip:2104 time:6667s

Blacklisted hosts:
shard-kbl total:3346 pass:1887 dwarn:1 dfail:0 fail:15 skip:1441 time:8899s

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_968/shards.html
_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev

Reviewed-by on v1 1/2
#4 lore raw
In reply to Maarten Lankhorst
Quoted 9 lines · Maarten Lankhorst

This gets rid of the following warnings:
lib/igt_kms.c:2688: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2738: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2788: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2812: warning: Parameter description for igt_pipe_obj_replace_prop_blob::pipe is not used from source code comment block. lib/igt_kms.c:2812: warning: Parameter description for igt_pipe_obj_replace_prop_blob::pipe_obj is missing in source code comment block. lib/igt_kms.c:3794: warning: Parameter description for igt_cleanup_hotplug::mon is missing in source code comment block.

both patches and pushed, thanks!
_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev