Skip to contentSkip to conversation

drm/vkms: Update VKMS documentation

PATCH In review Gabriela Bittencourt 2 participants 2 messages Nov 1, 2019 – Nov 4, 2019

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

PATCH 1/1 drm/vkms: Update VKMS documentation

Small changes in the driver documentation, clarifing the description.

---

Tested using: make htmldocs

---
 drivers/gpu/drm/vkms/vkms_drv.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/gpu/drm/vkms/vkms_drv.c +4 -4
index 80524a22412a..52e761bd6c2d 100644
@@ -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>
Signature · 1 line
2.20.1
#1 lore raw
Quoted 3 lines · Gabriela Bittencourt

Small changes in the driver documentation, clarifing the description.

lgtm, applied.
-Daniel

Quoted 30 lines

---

Tested using: make htmldocs

---
 drivers/gpu/drm/vkms/vkms_drv.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/gpu/drm/vkms/vkms_drv.c +4 -4
index 80524a22412a..52e761bd6c2d 100644
@@ -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>
Signature · 1 line
2.20.1
Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch