2019-11-01 22:41:11

by Gabriela Bittencourt

[permalink] [raw]
Subject: [PATCH] drm/vkms: Update VKMS documentation

Small changes in the driver documentation, clarifing the description.

Signed-off-by: Gabriela Bittencourt <[email protected]>

---

Tested using: make htmldocs
---
drivers/gpu/drm/vkms/vkms_drv.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/gpu/drm/vkms/vkms_drv.c b/drivers/gpu/drm/vkms/vkms_drv.c
index 80524a22412a..52e761bd6c2d 100644
--- a/drivers/gpu/drm/vkms/vkms_drv.c
+++ b/drivers/gpu/drm/vkms/vkms_drv.c
@@ -3,10 +3,10 @@
/**
* DOC: vkms (Virtual Kernel Modesetting)
*
- * vkms is a software-only model of a kms driver that is useful for testing,
- * or for running X (or similar) on headless machines and be able to still
- * use the GPU. vkms aims to enable a virtual display without the need for
- * a hardware display capability.
+ * VKMS is a software-only model of a KMS driver that is useful for testing
+ * and for running X (or similar) on headless machines. VKMS aims to enable
+ * a virtual display with no need of a hardware display capability, releasing
+ * the GPU in DRM API tests.
*/

#include <linux/module.h>
--
2.20.1


2019-11-04 17:43:06

by Daniel Vetter

[permalink] [raw]
Subject: Re: [PATCH] drm/vkms: Update VKMS documentation

On Fri, Nov 01, 2019 at 07:37:35PM -0300, Gabriela Bittencourt wrote:
> Small changes in the driver documentation, clarifing the description.
>
> Signed-off-by: Gabriela Bittencourt <[email protected]>

lgtm, applied.
-Daniel

>
> ---
>
> Tested using: make htmldocs
> ---
> drivers/gpu/drm/vkms/vkms_drv.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/gpu/drm/vkms/vkms_drv.c b/drivers/gpu/drm/vkms/vkms_drv.c
> index 80524a22412a..52e761bd6c2d 100644
> --- a/drivers/gpu/drm/vkms/vkms_drv.c
> +++ b/drivers/gpu/drm/vkms/vkms_drv.c
> @@ -3,10 +3,10 @@
> /**
> * DOC: vkms (Virtual Kernel Modesetting)
> *
> - * vkms is a software-only model of a kms driver that is useful for testing,
> - * or for running X (or similar) on headless machines and be able to still
> - * use the GPU. vkms aims to enable a virtual display without the need for
> - * a hardware display capability.
> + * VKMS is a software-only model of a KMS driver that is useful for testing
> + * and for running X (or similar) on headless machines. VKMS aims to enable
> + * a virtual display with no need of a hardware display capability, releasing
> + * the GPU in DRM API tests.
> */
>
> #include <linux/module.h>
> --
> 2.20.1
>

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch