Skip to contentSkip to conversation

drm/i915/doc: Drop stale references to GuC specific loader

PATCH In review Michal Wajdeczko 3 participants 5 messages Nov 15, 2017 – Nov 16, 2017

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

PATCH 1/1 drm/i915/doc: Drop stale references to GuC specific loader

In previous commit ("drm/i915/guc: Rename intel_guc_loader.c to intel_guc_fw.c") we unintentionally lost some of the structured comments referenced by kernel doc. Drop these stale references until we provide necessary updates to heavily re-factored code.

---
 Documentation/gpu/i915.rst | 9 ---------
 1 file changed, 9 deletions(-)
Documentation/gpu/i915.rst +0 -9
index 2e7ee03..fe725a2 100644
@@ -338,15 +338,6 @@ objects, which has the goal to make space in gpu virtual address spaces.
 GuC
 ===
 
-GuC-specific firmware loader
-----------------------------
-
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
-   :doc: GuC-specific firmware loader
-
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
-   :internal:
-
 GuC-based command submission
 ----------------------------
 
Signature · 6 lines
1.9.1

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

✓ Fi.CI.BAT: success for drm/i915/doc: Drop stale references to GuC specific loader

== Series Details ==

== Series Details ==

Series: drm/i915/doc: Drop stale references to GuC specific loader
URL : https://patchwork.freedesktop.org/series/33865/
State : success

== Summary ==

Series 33865v1 drm/i915/doc: Drop stale references to GuC specific loader
https://patchwork.freedesktop.org/api/1.0/series/33865/revisions/1/mbox/

Test kms_pipe_crc_basic:

        Subgroup read-crc-pipe-c:
                skip       -> PASS       (fi-hsw-4770r)
fi-bdw-5557u     total:289  pass:268  dwarn:0   dfail:0   fail:0   skip:21  time:446s
fi-bdw-gvtdvm    total:289  pass:265  dwarn:0   dfail:0   fail:0   skip:24  time:449s
fi-blb-e6850     total:289  pass:223  dwarn:1   dfail:0   fail:0   skip:65  time:377s
fi-bsw-n3050     total:289  pass:243  dwarn:0   dfail:0   fail:0   skip:46  time:537s
fi-bwr-2160      total:289  pass:183  dwarn:0   dfail:0   fail:0   skip:106 time:274s
fi-bxt-dsi       total:289  pass:259  dwarn:0   dfail:0   fail:0   skip:30  time:506s
fi-bxt-j4205     total:289  pass:260  dwarn:0   dfail:0   fail:0   skip:29  time:501s
fi-byt-j1900     total:289  pass:254  dwarn:0   dfail:0   fail:0   skip:35  time:496s
fi-byt-n2820     total:289  pass:250  dwarn:0   dfail:0   fail:0   skip:39  time:492s
fi-elk-e7500     total:289  pass:229  dwarn:0   dfail:0   fail:0   skip:60  time:430s
fi-glk-1         total:289  pass:261  dwarn:0   dfail:0   fail:0   skip:28  time:540s
fi-hsw-4770      total:289  pass:262  dwarn:0   dfail:0   fail:0   skip:27  time:432s
fi-hsw-4770r     total:289  pass:262  dwarn:0   dfail:0   fail:0   skip:27  time:438s
fi-ilk-650       total:289  pass:228  dwarn:0   dfail:0   fail:0   skip:61  time:425s
fi-ivb-3520m     total:289  pass:260  dwarn:0   dfail:0   fail:0   skip:29  time:478s
fi-ivb-3770      total:289  pass:260  dwarn:0   dfail:0   fail:0   skip:29  time:461s
fi-kbl-7500u     total:289  pass:264  dwarn:1   dfail:0   fail:0   skip:24  time:485s
fi-kbl-7560u     total:289  pass:270  dwarn:0   dfail:0   fail:0   skip:19  time:528s
fi-kbl-7567u     total:289  pass:269  dwarn:0   dfail:0   fail:0   skip:20  time:477s
fi-kbl-r         total:289  pass:262  dwarn:0   dfail:0   fail:0   skip:27  time:533s
fi-pnv-d510      total:289  pass:222  dwarn:1   dfail:0   fail:0   skip:66  time:567s
fi-skl-6260u     total:289  pass:269  dwarn:0   dfail:0   fail:0   skip:20  time:444s
fi-skl-6600u     total:289  pass:262  dwarn:0   dfail:0   fail:0   skip:27  time:542s
fi-skl-6700hq    total:289  pass:263  dwarn:0   dfail:0   fail:0   skip:26  time:565s
fi-skl-6700k     total:289  pass:265  dwarn:0   dfail:0   fail:0   skip:24  time:524s
fi-skl-6770hq    total:289  pass:269  dwarn:0   dfail:0   fail:0   skip:20  time:501s
fi-skl-gvtdvm    total:289  pass:266  dwarn:0   dfail:0   fail:0   skip:23  time:461s
fi-snb-2520m     total:289  pass:250  dwarn:0   dfail:0   fail:0   skip:39  time:553s
fi-snb-2600      total:289  pass:249  dwarn:0   dfail:0   fail:0   skip:40  time:425s
Blacklisted hosts:
fi-cfl-s         total:289  pass:254  dwarn:3   dfail:0   fail:0   skip:32  time:528s
fi-cnl-y         total:220  pass:199  dwarn:0   dfail:0   fail:0   skip:20 

2cac5c93bc9427509e5164289e810bdcabfc0351 drm-tip: 2017y-11m-15d-09h-10m-41s UTC integration manifest 07fe0302cc41 drm/i915/doc: Drop stale references to GuC specific loader

== Logs ==

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

#2 lore raw

✓ Fi.CI.IGT: success for drm/i915/doc: Drop stale references to GuC specific loader

In reply to Michal Wajdeczko
== Series Details ==

== Series Details ==

Series: drm/i915/doc: Drop stale references to GuC specific loader
URL : https://patchwork.freedesktop.org/series/33865/
State : success

== Summary ==

Test kms_busy:

        Subgroup extended-modeset-hang-newfb-with-reset-render-a:
                dmesg-warn -> PASS       (shard-hsw) fdo#102249 +2

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

shard-hsw total:2584 pass:1472 dwarn:3 dfail:1 fail:9 skip:1099 time:9450s
Blacklisted hosts:

shard-apl        total:2584 pass:1619 dwarn:1   dfail:2   fail:25  skip:936 time:13148s
shard-kbl        total:2565 pass:1685 dwarn:22  dfail:1   fail:26  skip:830 time:10551s
shard-snb        total:2578 pass:1197 dwarn:2   dfail:1   fail:12  skip:1365 time:7457s

== Logs ==

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

Reviewed-by on v1 1/1
#3 lore raw
In reply to Michal Wajdeczko
Quoted 8 lines · Michal Wajdeczko

In previous commit ("drm/i915/guc: Rename intel_guc_loader.c to intel_guc_fw.c") we unintentionally lost some of the structured comments referenced by kernel doc. Drop these stale references until we provide necessary updates to heavily re-factored code.

I see old documentation is still preserved in intel_guc_fw.c so adding referring it now will be good I guess. Refactoring documentation can be added on top.
Change looks good to me.

Quoted 14 lines
---
  Documentation/gpu/i915.rst | 9 ---------
  1 file changed, 9 deletions(-)
Documentation/gpu/i915.rst +0 -2
index 2e7ee03..fe725a2 100644
@@ -338,15 +338,6 @@ objects, which has the goal to make space in gpu virtual address spaces.
  GuC
  ===
 
-GuC-specific firmware loader
-----------------------------

Documentation/gpu/i915.rst objects, which has the goal to make space in gpu virtual address spaces. · line 343

Quoted 10 lines
Documentation/gpu/i915.rst +0 -7
-
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
-   :doc: GuC-specific firmware loader
-
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
-   :internal:
-
  GuC-based command submission
  ----------------------------
 

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

#4 lore raw
Quoted 8 lines · Sagar Arun Kamble
Quoted 5 lines · Michal Wajdeczko

In previous commit ("drm/i915/guc: Rename intel_guc_loader.c to intel_guc_fw.c") we unintentionally lost some of the structured comments referenced by kernel doc. Drop these stale references until we provide necessary updates to heavily re-factored code.

Quoted 4 lines
Quoted 3 lines

I see old documentation is still preserved in intel_guc_fw.c so adding referring it now will be good I guess.

Not quite. Old documentation is now spread across few files and it does not follow structured format required by kerneldoc tools.

Documentation in intel_guc_fw.c is for its public functions only, and when added to .rst alone it will not bring any value as user will still miss the base documentation about the firmware.

Thanks for the review,
Michal

Quoted 19 lines

Refactoring documentation can be added on top.
Change looks good to me.

Quoted 16 lines
---
  Documentation/gpu/i915.rst | 9 ---------
  1 file changed, 9 deletions(-)
Documentation/gpu/i915.rst +0 -0
index 2e7ee03..fe725a2 100644
@@ -338,15 +338,6 @@ objects, which has the goal to make space in gpu  

virtual address spaces.
GuC
===
-GuC-specific firmware loader
-----------------------------
-
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c

Quoted 8 lines

Documentation/gpu/i915.rst objects, which has the goal to make space in gpu virtual address spaces. · line 342

Quoted 8 lines
Documentation/gpu/i915.rst +0 -5
-   :doc: GuC-specific firmware loader
-
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
-   :internal:
-
  GuC-based command submission
  ----------------------------

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx