2021-01-10 14:09:30

by Sumera Priyadarsini

Subject: [PATCH V4 3/3] drm/vkms: Add information about module options

Update vkms documentation to contain usage of `modinfo`
command and steps to load vkms with module options enabled.

Signed-off-by: Sumera Priyadarsini <[email protected]>
---
Documentation/gpu/vkms.rst | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/Documentation/gpu/vkms.rst b/Documentation/gpu/vkms.rst
index 9e030c74a82e..45fe02f643a8 100644
--- a/Documentation/gpu/vkms.rst
+++ b/Documentation/gpu/vkms.rst
@@ -35,6 +35,16 @@ Now, to load the driver, use::
On running the lsmod command now, the VKMS driver will appear listed.
You can also observe the driver being loaded in the dmesg logs.

+You can use the `modinfo` command to see module options for vkms::
+
+ modinfo vkms
+
+Module options are helpful when testing, and enabling modules
+can be done while loading vkms. For example, to load vkms with cursor enabled,
+use::
+
+ sudo modprobe vkms enable_cursor=1
+
To disable the driver, use ::

sudo modprobe -r vkms
--
2.25.1

2021-01-11 10:11:41

by Daniel Vetter

Subject: Re: [PATCH V4 3/3] drm/vkms: Add information about module options

On Sun, Jan 10, 2021 at 07:35:41PM +0530, Sumera Priyadarsini wrote:
> Update vkms documentation to contain usage of `modinfo`
> command and steps to load vkms with module options enabled.
>
> Signed-off-by: Sumera Priyadarsini <[email protected]>
> ---
> Documentation/gpu/vkms.rst | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
> diff --git a/Documentation/gpu/vkms.rst b/Documentation/gpu/vkms.rst
> index 9e030c74a82e..45fe02f643a8 100644
> --- a/Documentation/gpu/vkms.rst
> +++ b/Documentation/gpu/vkms.rst
> @@ -35,6 +35,16 @@ Now, to load the driver, use::
> On running the lsmod command now, the VKMS driver will appear listed.
> You can also observe the driver being loaded in the dmesg logs.
>

Maybe start out with "vkms has optional features to simulate different
kinds of hardware, which are exposed as module options." Just to make it
clear why you'd want to look at module options and set them.

Otherwise lgtm, with that change on the entire series:

Acked-by: Daniel Vetter <[email protected]>

> +You can use the `modinfo` command to see module options for vkms::
> +
> + modinfo vkms
> +
> +Module options are helpful when testing, and enabling modules
> +can be done while loading vkms. For example, to load vkms with cursor enabled,
> +use::
> +
> + sudo modprobe vkms enable_cursor=1
> +
> To disable the driver, use ::
>
> sudo modprobe -r vkms
> --
> 2.25.1
>

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