Documentation/gpu: drm-mm.rst: fix formatting for struct vm_operations_struct
authorLiviu Dudau <Liviu.Dudau@arm.com>
Tue, 31 Jan 2017 17:41:09 +0000 (17:41 +0000)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 31 Jan 2017 20:15:49 +0000 (21:15 +0100)
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>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/20170131174109.13690-1-Liviu.Dudau@arm.com
Documentation/gpu/drm-mm.rst

index 91d82f39fbf47b32c7c59bab3ad173bcb3d8f355..f5760b140f13f19a3e27a037355e2875ea67006c 100644 (file)
@@ -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