diff options
| author | Jani Nikula <jani.nikula@intel.com> | 2016-06-21 14:49:00 +0300 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-06-21 14:15:18 +0200 |
| commit | 22554020409f6febcce2790380e46cd483ae04bb (patch) | |
| tree | 355dfc9c00ced4b9d312457e6c80beb470e159d7 /Documentation/gpu/introduction.rst | |
| parent | 621c5474744ce780a5485284273de77b66f4cae2 (diff) | |
Documentation/gpu: use recommended order of heading markers
While splitting the document up, the headings "shifted" from what pandoc
generated. Use the following order for headings for consistency:
==============
Document title
==============
First
=====
Second
------
Third
~~~~~
Leave the lower level headings as they are; I think those are less
important. Although RST doesn't mandate a specific order ("Rather than
imposing a fixed number and order of section title adornment styles, the
order enforced will be the order as encountered."), having the higher
levels the same overall makes it easier to follow the documents.
[I'm sort of kind of writing the recommendation for docs-next in the
mean time, but this order seems sensible, and is what I'm proposing.]
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/126f42734defac6cbb8496a481d58db7b38461dd.1466506505.git.jani.nikula@intel.com
Diffstat (limited to 'Documentation/gpu/introduction.rst')
| -rw-r--r-- | Documentation/gpu/introduction.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/gpu/introduction.rst b/Documentation/gpu/introduction.rst index cf35c4fe992f..1903595b5310 100644 --- a/Documentation/gpu/introduction.rst +++ b/Documentation/gpu/introduction.rst @@ -1,3 +1,4 @@ +============ Introduction ============ @@ -16,7 +17,7 @@ found in current kernels. [Insert diagram of typical DRM stack here] Style Guidelines ----------------- +================ For consistency this documentation uses American English. Abbreviations are written as all-uppercase, for example: DRM, KMS, IOCTL, CRTC, and so |