mbox series

[0/3] drm: Multiple documentation update

Message ID 20240409-google-drm-doc-v1-0-033d55cc8250@bootlin.com (mailing list archive)
Headers show
Series drm: Multiple documentation update | expand

Message

Louis Chauvet April 9, 2024, 10:04 a.m. UTC
PATCH 1 and PATCH 2 focus on the rotation property. The rotation property 
can be challenging to understand, especially when it is combined with 
reflections. These patches aim to provide clearer explanations and 
examples to aid in comprehension.

Patch 3 relates to the fourcc property. It includes additional details 
about block and char_per_block to provide a more comprehensive 
understanding of this feature.

Regarding PATCH 1, I would appreciate some feedback on the expected 
behavior. During a recent VKMS refactor, I used drm_rect_rotate as a 
reference for the rotation. However, during my testing phase, I noticed 
that the original VKMS implementation interpreted the rotation 
differently. Therefore, I kindly request that someone validate or 
invalidate my interpretation before proceeding with the merge.

Signed-off-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
Louis Chauvet (3):
      drm: drm_blend.c: Add precision in drm_rotation_simplify kernel doc
      drm: drm_blend.c: Improve drm_plane_create_rotation_property kernel doc
      drm/fourcc: Add documentation around drm_format_info

 drivers/gpu/drm/drm_blend.c | 57 ++++++++++++++++++++++++++++++++++-----------
 include/drm/drm_fourcc.h    | 45 +++++++++++++++++++++++++++++------
 2 files changed, 81 insertions(+), 21 deletions(-)
---
base-commit: e495e523b888a6155f82c767d34c8d712a41ee54
change-id: 20240327-google-drm-doc-cd275291792f

Best regards,

Comments

Jani Nikula April 9, 2024, 10:18 a.m. UTC | #1
On Tue, 09 Apr 2024, Louis Chauvet <louis.chauvet@bootlin.com> wrote:
> PATCH 1 and PATCH 2 focus on the rotation property. The rotation property 
> can be challenging to understand, especially when it is combined with 
> reflections. These patches aim to provide clearer explanations and 
> examples to aid in comprehension.
>
> Patch 3 relates to the fourcc property. It includes additional details 
> about block and char_per_block to provide a more comprehensive 
> understanding of this feature.
>
> Regarding PATCH 1, I would appreciate some feedback on the expected 
> behavior. During a recent VKMS refactor, I used drm_rect_rotate as a 
> reference for the rotation. However, during my testing phase, I noticed 
> that the original VKMS implementation interpreted the rotation 
> differently. Therefore, I kindly request that someone validate or 
> invalidate my interpretation before proceeding with the merge.

Did you run 'make htmldocs' and check the results after your changes?
I'm almost certain this botches up the layout.

BR,
Jani.

>
> Signed-off-by: Louis Chauvet <louis.chauvet@bootlin.com>
> ---
> Louis Chauvet (3):
>       drm: drm_blend.c: Add precision in drm_rotation_simplify kernel doc
>       drm: drm_blend.c: Improve drm_plane_create_rotation_property kernel doc
>       drm/fourcc: Add documentation around drm_format_info
>
>  drivers/gpu/drm/drm_blend.c | 57 ++++++++++++++++++++++++++++++++++-----------
>  include/drm/drm_fourcc.h    | 45 +++++++++++++++++++++++++++++------
>  2 files changed, 81 insertions(+), 21 deletions(-)
> ---
> base-commit: e495e523b888a6155f82c767d34c8d712a41ee54
> change-id: 20240327-google-drm-doc-cd275291792f
>
> Best regards,
Louis Chauvet April 9, 2024, 12:38 p.m. UTC | #2
Le 09/04/24 - 13:18, Jani Nikula a écrit :
> On Tue, 09 Apr 2024, Louis Chauvet <louis.chauvet@bootlin.com> wrote:
> > PATCH 1 and PATCH 2 focus on the rotation property. The rotation property 
> > can be challenging to understand, especially when it is combined with 
> > reflections. These patches aim to provide clearer explanations and 
> > examples to aid in comprehension.
> >
> > Patch 3 relates to the fourcc property. It includes additional details 
> > about block and char_per_block to provide a more comprehensive 
> > understanding of this feature.
> >
> > Regarding PATCH 1, I would appreciate some feedback on the expected 
> > behavior. During a recent VKMS refactor, I used drm_rect_rotate as a 
> > reference for the rotation. However, during my testing phase, I noticed 
> > that the original VKMS implementation interpreted the rotation 
> > differently. Therefore, I kindly request that someone validate or 
> > invalidate my interpretation before proceeding with the merge.
> 
> Did you run 'make htmldocs' and check the results after your changes?
> I'm almost certain this botches up the layout.

I did not think about htmldocs. I have a new version ready where the 
layout is fixed. Sorry about that.

I'll wait for more reviews before submitting it.

Thanks,
Louis Chauvet
 
> BR,
> Jani.
> 
> >
> > Signed-off-by: Louis Chauvet <louis.chauvet@bootlin.com>
> > ---
> > Louis Chauvet (3):
> >       drm: drm_blend.c: Add precision in drm_rotation_simplify kernel doc
> >       drm: drm_blend.c: Improve drm_plane_create_rotation_property kernel doc
> >       drm/fourcc: Add documentation around drm_format_info
> >
> >  drivers/gpu/drm/drm_blend.c | 57 ++++++++++++++++++++++++++++++++++-----------
> >  include/drm/drm_fourcc.h    | 45 +++++++++++++++++++++++++++++------
> >  2 files changed, 81 insertions(+), 21 deletions(-)
> > ---
> > base-commit: e495e523b888a6155f82c767d34c8d712a41ee54
> > change-id: 20240327-google-drm-doc-cd275291792f
> >
> > Best regards,
> 
> -- 
> Jani Nikula, Intel