Skip to contentSkip to conversation

drm/i915/guc: Fix doc reference to intel_guc_fw.c

PATCH In review Jonathan Neuschäfer 3 participants 5 messages Nov 28, 2017 – Nov 29, 2017

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

PATCH 1/1 drm/i915/guc: Fix doc reference to intel_guc_fw.c

Sphinx complains that it can't find intel_guc_loader.c, and rightly so:
The file has been renamed.

Fixes e8668bbcb0f9 ("drm/i915/guc: Rename intel_guc_loader.c to intel_guc_fw.c")
Cc Michal Wajdeczko <[email protected]>
---
 Documentation/gpu/i915.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/gpu/i915.rst +2 -2
index 2e7ee0313c1c..e21698e16534 100644
@@ -341,10 +341,10 @@ GuC
 GuC-specific firmware loader
 ----------------------------
 
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :doc: GuC-specific firmware loader
 
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :internal:
 
 GuC-based command submission
Signature · 1 line
2.15.0
#1 lore raw
Quoted 23 lines · Jonathan Neuschäfer

Sphinx complains that it can't find intel_guc_loader.c, and rightly so:
The file has been renamed.

Fixes e8668bbcb0f9 ("drm/i915/guc: Rename intel_guc_loader.c to intel_guc_fw.c")
Cc Michal Wajdeczko <[email protected]>
---
 Documentation/gpu/i915.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/gpu/i915.rst +2 -2
index 2e7ee0313c1c..e21698e16534 100644
@@ -341,10 +341,10 @@ GuC
 GuC-specific firmware loader
 ----------------------------
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :doc: GuC-specific firmware loader
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :internal:
Quoted 1 line

GuC-based command submission

+ Ville

Well, this will fix sphinx error, but in my opinion it will not make i915 documentation any better. See my earlier patch/comments in [1]. So maybe better to wait for other comments which way to go.

Thanks for the patch,
Michal

[1] https://patchwork.freedesktop.org/patch/188424/

#2 lore raw
Quoted 31 lines · Michal Wajdeczko
Quoted 24 lines · Jonathan Neuschäfer

Sphinx complains that it can't find intel_guc_loader.c, and rightly so:
The file has been renamed.

Fixes e8668bbcb0f9 ("drm/i915/guc: Rename intel_guc_loader.c to

intel_guc_fw.c")

---
 Documentation/gpu/i915.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/gpu/i915.rst +2 -2
index 2e7ee0313c1c..e21698e16534 100644
@@ -341,10 +341,10 @@ GuC
 GuC-specific firmware loader
 ----------------------------
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :doc: GuC-specific firmware loader
-.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :internal:
Quoted 1 line

GuC-based command submission

+ Ville

Quoted 2 lines

Well, this will fix sphinx error, but in my opinion it will not make i915 documentation any better. See my earlier patch/comments in [1].

Thanks for the pointer.

Hmm, right, given that there's no "DOC:" line in intel_guc_fw.c anymore, the ":doc:" directive above is not useful.

As a tiny step towards more complete documentation (and to keep people from patching this spot again ;), IMHO it makes sense to do this (it's of course up to the maintainers whether they agree):

-----------------------------------------------------------------------

Documentation/gpu/i915.rst +1 -4
index 2e7ee0313c1c..e94d3ac2bdd0 100644
@@ -341,10 +341,7 @@ 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
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c
    :internal:
 
 GuC-based command submission

-----------------------------------------------------------------------

Quoted 1 line

So maybe better to wait for other comments which way to go.

Makes sense.

Thanks,
Jonathan Neuschäfer

Quoted 5 lines

Thanks for the patch,
Michal

[1] https://patchwork.freedesktop.org/patch/188424/

#3 lore raw

✓ Fi.CI.BAT: success for drm/i915/guc: Fix doc reference to intel_guc_fw.c

In reply to Jonathan Neuschäfer
== Series Details ==

== Series Details ==

Series: drm/i915/guc: Fix doc reference to intel_guc_fw.c
URL : https://patchwork.freedesktop.org/series/34557/
State : success

== Summary ==

Series 34557v1 drm/i915/guc: Fix doc reference to intel_guc_fw.c
https://patchwork.freedesktop.org/api/1.0/series/34557/revisions/1/mbox/

Test kms_cursor_legacy:

        Subgroup basic-busy-flip-before-cursor-legacy:
                pass       -> FAIL       (fi-gdg-551) fdo#102618

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

fi-bdw-5557u     total:288  pass:267  dwarn:0   dfail:0   fail:0   skip:21  time:442s
fi-bdw-gvtdvm    total:288  pass:264  dwarn:0   dfail:0   fail:0   skip:24  time:445s
fi-blb-e6850     total:288  pass:223  dwarn:1   dfail:0   fail:0   skip:64  time:389s
fi-bsw-n3050     total:288  pass:242  dwarn:0   dfail:0   fail:0   skip:46  time:514s
fi-bwr-2160      total:288  pass:183  dwarn:0   dfail:0   fail:0   skip:105 time:279s
fi-bxt-dsi       total:288  pass:258  dwarn:0   dfail:0   fail:0   skip:30  time:498s
fi-bxt-j4205     total:288  pass:259  dwarn:0   dfail:0   fail:0   skip:29  time:500s
fi-byt-j1900     total:288  pass:253  dwarn:0   dfail:0   fail:0   skip:35  time:484s
fi-byt-n2820     total:288  pass:249  dwarn:0   dfail:0   fail:0   skip:39  time:465s
fi-elk-e7500     total:288  pass:229  dwarn:0   dfail:0   fail:0   skip:59  time:424s
fi-gdg-551       total:288  pass:177  dwarn:1   dfail:0   fail:2   skip:108 time:278s
fi-glk-1         total:288  pass:260  dwarn:0   dfail:0   fail:0   skip:28  time:537s
fi-hsw-4770      total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:370s
fi-hsw-4770r     total:288  pass:224  dwarn:0   dfail:0   fail:0   skip:64  time:258s
fi-ilk-650       total:288  pass:228  dwarn:0   dfail:0   fail:0   skip:60  time:428s
fi-ivb-3520m     total:288  pass:259  dwarn:0   dfail:0   fail:0   skip:29  time:480s
fi-kbl-7500u     total:288  pass:263  dwarn:1   dfail:0   fail:0   skip:24  time:481s
fi-kbl-7560u     total:288  pass:269  dwarn:0   dfail:0   fail:0   skip:19  time:530s
fi-kbl-7567u     total:288  pass:268  dwarn:0   dfail:0   fail:0   skip:20  time:474s
fi-kbl-r         total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:523s
fi-pnv-d510      total:288  pass:222  dwarn:1   dfail:0   fail:0   skip:65  time:583s
fi-skl-6260u     total:288  pass:268  dwarn:0   dfail:0   fail:0   skip:20  time:446s
fi-skl-6600u     total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:538s
fi-skl-6700hq    total:288  pass:262  dwarn:0   dfail:0   fail:0   skip:26  time:558s
fi-skl-6700k     total:288  pass:264  dwarn:0   dfail:0   fail:0   skip:24  time:515s
fi-skl-6770hq    total:288  pass:268  dwarn:0   dfail:0   fail:0   skip:20  time:507s
fi-skl-gvtdvm    total:288  pass:265  dwarn:0   dfail:0   fail:0   skip:23  time:447s
fi-snb-2520m     total:288  pass:249  dwarn:0   dfail:0   fail:0   skip:39  time:550s
fi-snb-2600      total:288  pass:248  dwarn:0   dfail:0   fail:0   skip:40  time:414s
Blacklisted hosts:
fi-cfl-s2        total:288  pass:262  dwarn:0   dfail:0   fail:0   skip:26  time:603s
fi-cnl-y         total:288  pass:261  dwarn:0   dfail:0   fail:0   skip:27  time:557s
fi-glk-dsi       total:288  pass:258  dwarn:0   dfail:0   fail:0   skip:30  time:478s

5144438448829ec2a3d94fd16a9e69a52cfa7b3b drm-tip: 2017y-11m-28d-17h-04m-56s UTC integration manifest 199eb77ebe81 drm/i915/guc: Fix doc reference to intel_guc_fw.c

== Logs ==

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

#4 lore raw

✓ Fi.CI.IGT: success for drm/i915/guc: Fix doc reference to intel_guc_fw.c

In reply to Jonathan Neuschäfer
== Series Details ==

== Series Details ==

Series: drm/i915/guc: Fix doc reference to intel_guc_fw.c
URL : https://patchwork.freedesktop.org/series/34557/
State : success

== Summary ==

Blacklisted hosts:

shard-hsw        total:2560 pass:1471 dwarn:8   dfail:0   fail:9   skip:1071 time:8745s
shard-snb        total:2588 pass:1239 dwarn:19  dfail:6   fail:7   skip:1313 time:7811s

== Logs ==

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