Re: [Intel-gfx] ✗ Fi.CI.BUILD: failure for drm/i915: Add Sphinx-compatible references to struct fields
On Mon, Oct 07, 2019 at 02:36:30PM +0300, Jani Nikula wrote:
> On Fri, 04 Oct 2019, Jonathan Neuschäfer wrote:
[...]
> > I'm not sure what's wrong here. The patch applies cleanly to v5.4-rc1
> > and linux-next. Maybe patchwork is applying it to an older base?
>
> On the contrary, to a much newer base. Try drm-tip branch of [1].
>
> BR,
> Jani.
>
> [1] https://cgit.freedesktop.org/drm/drm-tip
Thanks for the hint!
Turns out someone already sent a similar fix, commit 56316cbc9c98
("drm/i915/perf: Fix use of kernel-doc format in structure members").
Jonathan Neuschäfer
signature.asc
Description: PGP signature
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [Intel-gfx] ✗ Fi.CI.BUILD: failure for drm/i915: Add Sphinx-compatible references to struct fields
On Thu, Oct 03, 2019 at 06:45:56PM -, Patchwork wrote: > == Series Details == > > Series: drm/i915: Add Sphinx-compatible references to struct fields > URL : https://patchwork.freedesktop.org/series/67550/ > State : failure > > == Summary == > > Applying: drm/i915: Add Sphinx-compatible references to struct fields > Using index info to reconstruct a base tree... > M drivers/gpu/drm/i915/i915_drv.h > Falling back to patching base and 3-way merge... > Auto-merging drivers/gpu/drm/i915/i915_drv.h > CONFLICT (content): Merge conflict in drivers/gpu/drm/i915/i915_drv.h I'm not sure what's wrong here. The patch applies cleanly to v5.4-rc1 and linux-next. Maybe patchwork is applying it to an older base? Thanks, Jonathan Neuschäfer signature.asc Description: PGP signature ___ Intel-gfx mailing list Intel-gfx@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/intel-gfx
[Intel-gfx] [PATCH] drm/i915: Add Sphinx-compatible references to struct fields
This fixes the following kernel-doc warnings and makes the corrsponding fields
show up in the generated HTML:
./drivers/gpu/drm/i915/i915_drv.h:1143: warning: Incorrect use of kernel-doc
format: * State of the OA buffer.
./drivers/gpu/drm/i915/i915_drv.h:1154: warning: Incorrect use of kernel-doc
format: * Locks reads and writes to all head/tail state
./drivers/gpu/drm/i915/i915_drv.h:1176: warning: Incorrect use of kernel-doc
format: * One 'aging' tail pointer and one 'aged' tail pointer
ready to
./drivers/gpu/drm/i915/i915_drv.h:1188: warning: Incorrect use of kernel-doc
format: * Index for the aged tail ready to read() data up to.
./drivers/gpu/drm/i915/i915_drv.h:1193: warning: Incorrect use of kernel-doc
format: * A monotonic timestamp for when the current aging
tail pointer
./drivers/gpu/drm/i915/i915_drv.h:1199: warning: Incorrect use of kernel-doc
format: * Although we can always read back the head pointer
register,
Signed-off-by: Jonathan Neuschäfer
---
drivers/gpu/drm/i915/i915_drv.h | 7 ++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/i915/i915_drv.h b/drivers/gpu/drm/i915/i915_drv.h
index 772154e4073e..55782e78f026 100644
--- a/drivers/gpu/drm/i915/i915_drv.h
+++ b/drivers/gpu/drm/i915/i915_drv.h
@@ -1140,7 +1140,7 @@ struct i915_perf_stream {
int period_exponent;
/**
-* State of the OA buffer.
+* @oa_buffer: State of the OA buffer.
*/
struct {
struct i915_vma *vma;
@@ -1151,6 +1151,7 @@ struct i915_perf_stream {
int size_exponent;
/**
+* @oa_buffer.ptr_lock:
* Locks reads and writes to all head/tail state
*
* Consider: the head and tail pointer state needs to be read
@@ -1173,6 +1174,7 @@ struct i915_perf_stream {
spinlock_t ptr_lock;
/**
+* @oa_buffer.tails:
* One 'aging' tail pointer and one 'aged' tail pointer ready to
* used for reading.
*
@@ -1185,17 +1187,20 @@ struct i915_perf_stream {
} tails[2];
/**
+* @oa_buffer.aged_tail_idx:
* Index for the aged tail ready to read() data up to.
*/
unsigned int aged_tail_idx;
/**
+* @oa_buffer.aging_timestamp:
* A monotonic timestamp for when the current aging tail pointer
* was read; used to determine when it is old enough to trust.
*/
u64 aging_timestamp;
/**
+* @oa_buffer.head:
* Although we can always read back the head pointer register,
* we prefer to avoid trusting the HW state, just to avoid any
* risk that some hardware condition could * somehow bump the
--
2.20.1
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
[Intel-gfx] [PATCH] 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 <michal.wajdec...@intel.com>
Signed-off-by: Jonathan Neuschäfer <j.neuschae...@gmx.net>
---
Documentation/gpu/i915.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 2e7ee0313c1c..e21698e16534 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -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
--
2.15.0
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [Intel-gfx] [PATCH] drm/i915/guc: Fix doc reference to intel_guc_fw.c
On Tue, Nov 28, 2017 at 09:51:13AM +0100, Michal Wajdeczko wrote:
> On Tue, 28 Nov 2017 07:50:52 +0100, Jonathan Neuschäfer
> <j.neuschae...@gmx.net> wrote:
>
> > 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 <michal.wajdec...@intel.com>
> > Signed-off-by: Jonathan Neuschäfer <j.neuschae...@gmx.net>
> > ---
> > Documentation/gpu/i915.rst | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> > index 2e7ee0313c1c..e21698e16534 100644
> > --- a/Documentation/gpu/i915.rst
> > +++ b/Documentation/gpu/i915.rst
> > @@ -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
>
> + 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].
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):
---
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 2e7ee0313c1c..e94d3ac2bdd0 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -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
---
> So maybe better to wait for other comments which way to go.
Makes sense.
Thanks,
Jonathan Neuschäfer
>
> Thanks for the patch,
> Michal
>
> [1] https://patchwork.freedesktop.org/patch/188424/
signature.asc
Description: PGP signature
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
