Documentation: convert DocBook gpu.tmpl to reStructuredText

Submitted by Jani Nikula on June 20, 2016, 3:07 p.m.

Details

Reviewer None
Submitted June 20, 2016, 3:07 p.m.
Last Updated June 21, 2016, 12:29 p.m.
Revision 2

Cover Letter(s)

Revision 1
      Hi all, this series converts the DocBook gpu.tmpl to reStructuredText,
now that we have Sphinx support merged to docs-next and drm-next.

I haven't really touched the content, this is just a fairly mechanical
conversion and split up of the document. I'm sure there are small issues
here and there, but I think it would be more beneficial to spread the
load of fixing things up instead of me tweaking it in a corner by myself
ad infinitum.

Moreover, I think it's a good time to look at the documentation from a
broader perspective (and IMO it's actually easier to grasp that when
it's in RST and built with Sphinx), so perhaps it would be better to
tweak the remaining formatting issues while improving the documentation
as a whole.

Cc: Jon and linux-doc as FYI, but I think we'd like to merge this via
drm-next.

Comments welcome.


BR,
Jani.


Jani Nikula (6):
  Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmpl
  Documentation/gpu: split up the gpu documentation
  MAINTAINERS: add Documentation/gpu and Documentation/gpu/i915.rst
  Documentation/gpu: use recommended order of heading markers
  Documentation/gpu: convert the KMS properties table to CSV
  Documentation/DocBook: remove gpu.tmpl

 Documentation/DocBook/Makefile                |    2 +-
 Documentation/DocBook/gpu.tmpl                | 3528 -------------------------
 Documentation/gpu/drm-internals.rst           | 1745 ++++++++++++
 Documentation/gpu/drm-userland-interfaces.rst |   92 +
 Documentation/gpu/i915.rst                    |  347 +++
 Documentation/gpu/index.rst                   |   11 +
 Documentation/gpu/introduction.rst            |   51 +
 Documentation/gpu/kms-properties.csv          |  128 +
 Documentation/gpu/vga-switcheroo.rst          |  102 +
 Documentation/index.rst                       |    1 +
 MAINTAINERS                                   |    3 +-
 11 files changed, 2480 insertions(+), 3530 deletions(-)
 delete mode 100644 Documentation/DocBook/gpu.tmpl
 create mode 100644 Documentation/gpu/drm-internals.rst
 create mode 100644 Documentation/gpu/drm-userland-interfaces.rst
 create mode 100644 Documentation/gpu/i915.rst
 create mode 100644 Documentation/gpu/index.rst
 create mode 100644 Documentation/gpu/introduction.rst
 create mode 100644 Documentation/gpu/kms-properties.csv
 create mode 100644 Documentation/gpu/vga-switcheroo.rst
    
Revision 2
      Take two of [1], see the cover letter there.

I've renamed drm-userland-interfaces.rst to drm-uapi.rst and added a
further split-up patch of drm internals, extracting mm, kms and kms
helpers to separate documents.

BR,
Jani.

[1] http://mid.gmane.org/cover.1466434348.git.jani.nikula@intel.com


Jani Nikula (7):
  Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmpl
  Documentation/gpu: split up the gpu documentation
  MAINTAINERS: add Documentation/gpu and Documentation/gpu/i915.rst
  Documentation/gpu: use recommended order of heading markers
  Documentation/gpu: convert the KMS properties table to CSV
  Documentation/gpu: split up mm, kms and kms-helpers from internals
  Documentation/DocBook: remove gpu.tmpl

 Documentation/DocBook/Makefile        |    2 +-
 Documentation/DocBook/gpu.tmpl        | 3528 ---------------------------------
 Documentation/gpu/drm-internals.rst   |  378 ++++
 Documentation/gpu/drm-kms-helpers.rst |  260 +++
 Documentation/gpu/drm-kms.rst         |  656 ++++++
 Documentation/gpu/drm-mm.rst          |  454 +++++
 Documentation/gpu/drm-uapi.rst        |   92 +
 Documentation/gpu/i915.rst            |  347 ++++
 Documentation/gpu/index.rst           |   14 +
 Documentation/gpu/introduction.rst    |   51 +
 Documentation/gpu/kms-properties.csv  |  128 ++
 Documentation/gpu/vga-switcheroo.rst  |  102 +
 Documentation/index.rst               |    1 +
 MAINTAINERS                           |    3 +-
 14 files changed, 2486 insertions(+), 3530 deletions(-)
 delete mode 100644 Documentation/DocBook/gpu.tmpl
 create mode 100644 Documentation/gpu/drm-internals.rst
 create mode 100644 Documentation/gpu/drm-kms-helpers.rst
 create mode 100644 Documentation/gpu/drm-kms.rst
 create mode 100644 Documentation/gpu/drm-mm.rst
 create mode 100644 Documentation/gpu/drm-uapi.rst
 create mode 100644 Documentation/gpu/i915.rst
 create mode 100644 Documentation/gpu/index.rst
 create mode 100644 Documentation/gpu/introduction.rst
 create mode 100644 Documentation/gpu/kms-properties.csv
 create mode 100644 Documentation/gpu/vga-switcheroo.rst
    

Revisions

Patches download mbox

Tests

Applying: Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmpl
Using index info to reconstruct a base tree...
M	Documentation/index.rst
Falling back to patching base and 3-way merge...
Auto-merging Documentation/index.rst
CONFLICT (content): Merge conflict in Documentation/index.rst
error: Failed to merge in the changes.
Patch failed at 0001 Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmpl
The copy of the patch that failed is found in: .git/rebase-apply/patch
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Patches download mbox

Tests

Applying: Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmpl
Using index info to reconstruct a base tree...
M	Documentation/index.rst
Falling back to patching base and 3-way merge...
Auto-merging Documentation/index.rst
CONFLICT (content): Merge conflict in Documentation/index.rst
error: Failed to merge in the changes.
Patch failed at 0001 Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmpl
The copy of the patch that failed is found in: .git/rebase-apply/patch
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".