diff options
| author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2019-12-04 11:19:33 +0100 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2019-12-10 21:44:02 +0100 |
| commit | 6acc942c5eecad34a7623e01317f3d03d1e05462 (patch) | |
| tree | d2026d57edc7d6ed0888e2675efd3a4acc86d6d9 /Documentation/gpu/drm-kms.rst | |
| parent | drm/atomic: Update docs around locking and commit sequencing (diff) | |
| download | linux-6acc942c5eecad34a7623e01317f3d03d1e05462.tar.xz linux-6acc942c5eecad34a7623e01317f3d03d1e05462.zip | |
drm/doc: Drop :c:func: markup
Kernel sphinx has learned how to do that in
commit d74b0d31dddeac2b44c715588d53d9a1e5b1158e
Author: Jonathan Corbet <corbet@lwn.net>
Date: Thu Apr 25 07:55:07 2019 -0600
Docs: An initial automarkup extension for sphinx
Unfortunately it hasn't learned that yet for structures, so we're
stuck with the :c:type: noise for now still.
Reviewed-by: Thierry Reding <treding@nvidia.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20191204101933.861169-1-daniel.vetter@ffwll.ch
Diffstat (limited to 'Documentation/gpu/drm-kms.rst')
| -rw-r--r-- | Documentation/gpu/drm-kms.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst index b9330343d1bc..906771e03103 100644 --- a/Documentation/gpu/drm-kms.rst +++ b/Documentation/gpu/drm-kms.rst @@ -3,7 +3,7 @@ Kernel Mode Setting (KMS) ========================= Drivers must initialize the mode setting core by calling -:c:func:`drm_mode_config_init()` on the DRM device. The function +drm_mode_config_init() on the DRM device. The function initializes the :c:type:`struct drm_device <drm_device>` mode_config field and never fails. Once done, mode configuration must be setup by initializing the following fields. @@ -181,8 +181,7 @@ Setting`_). The somewhat surprising part here is that properties are not directly instantiated on each object, but free-standing mode objects themselves, represented by :c:type:`struct drm_property <drm_property>`, which only specify the type and value range of a property. Any given property can be attached -multiple times to different objects using :c:func:`drm_object_attach_property() -<drm_object_attach_property>`. +multiple times to different objects using drm_object_attach_property(). .. kernel-doc:: include/drm/drm_mode_object.h :internal: @@ -274,7 +273,7 @@ Locking of atomic state structures is internally using :c:type:`struct drm_modeset_lock <drm_modeset_lock>`. As a general rule the locking shouldn't be exposed to drivers, instead the right locks should be automatically acquired by any function that duplicates or peeks into a state, like e.g. -:c:func:`drm_atomic_get_crtc_state()`. Locking only protects the software data +drm_atomic_get_crtc_state(). Locking only protects the software data structure, ordering of committing state changes to hardware is sequenced using :c:type:`struct drm_crtc_commit <drm_crtc_commit>`. |