diff mbox

[1/5] drm/docs: Discourage adding more to kms-properties.csv

Message ID 20180219225356.24996-1-daniel.vetter@ffwll.ch (mailing list archive)
State New, archived
Headers show

Commit Message

Daniel Vetter Feb. 19, 2018, 10:53 p.m. UTC
Motivated by patch review.

The table is really hard to read in source form, hard to edit, and
we've moved away to more focused sections about specific features and
how they're exposed in properties.

Those sections can then more easily enumerate options, link to helper
functions and other parts of the docs. All things that get ugly real
fast in the docs.

Cc: Maxime Ripard <maxime.ripard@bootlin.com>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 Documentation/gpu/drm-kms.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Thierry Reding Feb. 20, 2018, 9:41 a.m. UTC | #1
On Mon, Feb 19, 2018 at 11:53:52PM +0100, Daniel Vetter wrote:
> Motivated by patch review.
> 
> The table is really hard to read in source form, hard to edit, and
> we've moved away to more focused sections about specific features and
> how they're exposed in properties.
> 
> Those sections can then more easily enumerate options, link to helper
> functions and other parts of the docs. All things that get ugly real
> fast in the docs.
> 
> Cc: Maxime Ripard <maxime.ripard@bootlin.com>
> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  Documentation/gpu/drm-kms.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)

Reviewed-by: Thierry Reding <treding@nvidia.com>
Laurent Pinchart Feb. 21, 2018, 12:23 a.m. UTC | #2
Hi Daniel,

Thank you for the patch.

On Tuesday, 20 February 2018 00:53:52 EET Daniel Vetter wrote:
> Motivated by patch review.
> 
> The table is really hard to read in source form, hard to edit, and
> we've moved away to more focused sections about specific features and
> how they're exposed in properties.
> 
> Those sections can then more easily enumerate options, link to helper
> functions and other parts of the docs. All things that get ugly real
> fast in the docs.
> 
> Cc: Maxime Ripard <maxime.ripard@bootlin.com>
> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>

Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/gpu/drm-kms.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
> index 2dcf5b42015d..56a3780e39b8 100644
> --- a/Documentation/gpu/drm-kms.rst
> +++ b/Documentation/gpu/drm-kms.rst
> @@ -547,8 +547,9 @@ Explicit Fencing Properties
>  Existing KMS Properties
>  -----------------------
> 
> -The following table gives description of drm properties exposed by
> -various modules/drivers.
> +The following table gives description of drm properties exposed by various
> +modules/drivers. Because this table is very unwieldy, do not add any new
> +properties here. Instead document them in a section above.
> 
>  .. csv-table::
>     :header-rows: 1
diff mbox

Patch

diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
index 2dcf5b42015d..56a3780e39b8 100644
--- a/Documentation/gpu/drm-kms.rst
+++ b/Documentation/gpu/drm-kms.rst
@@ -547,8 +547,9 @@  Explicit Fencing Properties
 Existing KMS Properties
 -----------------------
 
-The following table gives description of drm properties exposed by
-various modules/drivers.
+The following table gives description of drm properties exposed by various
+modules/drivers. Because this table is very unwieldy, do not add any new
+properties here. Instead document them in a section above.
 
 .. csv-table::
    :header-rows: 1