* [PATCH] Documentation/gpu: drm-mm.rst: fix formatting for struct vm_operations_struct
@ 2017-01-31 17:41 Liviu Dudau
2017-01-31 20:11 ` Daniel Vetter
0 siblings, 1 reply; 2+ messages in thread
From: Liviu Dudau @ 2017-01-31 17:41 UTC (permalink / raw)
To: David Airlie, Daniel Vetter, Jonathan Corbet
Cc: LKML, Liviu Dudau, DRI devel, linux-doc
drm-mm.rst contains some unformatted dump of the vm_operations_struct
structure. Add some C formatting around it and some context for the
dump. While there, update the structure to resemble the new signature
for the fault handler after commit 25d3db7600b8 (mm, fs: reduce fault,
page_mkwrite, and pfn_mkwrite to take only vmf).
Signed-off-by: Liviu Dudau <liviu.dudau@arm.com>
---
Documentation/gpu/drm-mm.rst | 15 +++++++++++----
1 file changed, 11 insertions(+), 4 deletions(-)
diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
index 91d82f39fbf4..a1c0ae3b2c38 100644
--- a/Documentation/gpu/drm-mm.rst
+++ b/Documentation/gpu/drm-mm.rst
@@ -291,10 +291,17 @@ To use :c:func:`drm_gem_mmap()`, drivers must fill the struct
:c:type:`struct drm_driver <drm_driver>` gem_vm_ops field
with a pointer to VM operations.
-struct vm_operations_struct \*gem_vm_ops struct
-vm_operations_struct { void (\*open)(struct vm_area_struct \* area);
-void (\*close)(struct vm_area_struct \* area); int (\*fault)(struct
-vm_area_struct \*vma, struct vm_fault \*vmf); };
+The VM operations is a :c:type:`struct vm_operations_struct <vm_operations_struct>`
+made up of several fields, the more interesting ones being:
+
+.. code-block:: c
+
+ struct vm_operations_struct {
+ void (*open)(struct vm_area_struct * area);
+ void (*close)(struct vm_area_struct * area);
+ int (*fault)(struct vm_fault *vmf);
+ };
+
The open and close operations must update the GEM object reference
count. Drivers can use the :c:func:`drm_gem_vm_open()` and
--
2.11.0
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation/gpu: drm-mm.rst: fix formatting for struct vm_operations_struct
2017-01-31 17:41 [PATCH] Documentation/gpu: drm-mm.rst: fix formatting for struct vm_operations_struct Liviu Dudau
@ 2017-01-31 20:11 ` Daniel Vetter
0 siblings, 0 replies; 2+ messages in thread
From: Daniel Vetter @ 2017-01-31 20:11 UTC (permalink / raw)
To: Liviu Dudau; +Cc: linux-doc, Jonathan Corbet, LKML, DRI devel, Daniel Vetter
On Tue, Jan 31, 2017 at 05:41:09PM +0000, Liviu Dudau wrote:
> drm-mm.rst contains some unformatted dump of the vm_operations_struct
> structure. Add some C formatting around it and some context for the
> dump. While there, update the structure to resemble the new signature
> for the fault handler after commit 25d3db7600b8 (mm, fs: reduce fault,
> page_mkwrite, and pfn_mkwrite to take only vmf).
>
> Signed-off-by: Liviu Dudau <liviu.dudau@arm.com>
Applied, thanks.
-Daniel
> ---
> Documentation/gpu/drm-mm.rst | 15 +++++++++++----
> 1 file changed, 11 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> index 91d82f39fbf4..a1c0ae3b2c38 100644
> --- a/Documentation/gpu/drm-mm.rst
> +++ b/Documentation/gpu/drm-mm.rst
> @@ -291,10 +291,17 @@ To use :c:func:`drm_gem_mmap()`, drivers must fill the struct
> :c:type:`struct drm_driver <drm_driver>` gem_vm_ops field
> with a pointer to VM operations.
>
> -struct vm_operations_struct \*gem_vm_ops struct
> -vm_operations_struct { void (\*open)(struct vm_area_struct \* area);
> -void (\*close)(struct vm_area_struct \* area); int (\*fault)(struct
> -vm_area_struct \*vma, struct vm_fault \*vmf); };
> +The VM operations is a :c:type:`struct vm_operations_struct <vm_operations_struct>`
> +made up of several fields, the more interesting ones being:
> +
> +.. code-block:: c
> +
> + struct vm_operations_struct {
> + void (*open)(struct vm_area_struct * area);
> + void (*close)(struct vm_area_struct * area);
> + int (*fault)(struct vm_fault *vmf);
> + };
> +
>
> The open and close operations must update the GEM object reference
> count. Drivers can use the :c:func:`drm_gem_vm_open()` and
> --
> 2.11.0
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-01-31 20:11 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-01-31 17:41 [PATCH] Documentation/gpu: drm-mm.rst: fix formatting for struct vm_operations_struct Liviu Dudau
2017-01-31 20:11 ` Daniel Vetter
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).