diff options
| author | Jani Nikula <jani.nikula@intel.com> | 2017-08-10 15:29:44 +0300 |
|---|---|---|
| committer | Jani Nikula <jani.nikula@intel.com> | 2017-08-10 22:47:32 +0300 |
| commit | 1aa920ea0e85d8417c7aa404f50244481e82f0c3 (patch) | |
| tree | be4b442a0bbf434544d4020b87603ad70c9cbf97 /Documentation/gpu | |
| parent | c3fdb9d8fc0a92a5eb158c1cf91c6c6bae36bb77 (diff) | |
drm/i915: add register macro definition style guide
This is not to try to force a new style; this is my interpretation of
what the most common existing style is.
With hopes I don't need to answer so many questions about style going
forward.
Start a new style section in the i915 document to bolt the register
style guide into.
v2: vertical alignment, incorporate to kernel-doc, and more
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Reviewed-by: Dhinakaran Pandiyan <dhinakaran.pandiyan@intel.com>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/9de4a5b1bea4e76461c70a1dd66751581de0124f.1502368010.git.jani.nikula@intel.com
Diffstat (limited to 'Documentation/gpu')
| -rw-r--r-- | Documentation/gpu/i915.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst index 32c32b89e2e5..2e7ee0313c1c 100644 --- a/Documentation/gpu/i915.rst +++ b/Documentation/gpu/i915.rst @@ -480,3 +480,17 @@ specific details than found in the more high-level sections. .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c :internal: + +Style +===== + +The drm/i915 driver codebase has some style rules in addition to (and, in some +cases, deviating from) the kernel coding style. + +Register macro definition style +------------------------------- + +The style guide for ``i915_reg.h``. + +.. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h + :doc: The i915 register macro definition style guide |