[02/15] DocBook: Add vga_switcheroo Subsystem Guide
diff mbox

Message ID 37cbdedaac83c189ae35b9627a403e0e25b07bb0.1442497843.git.lukas@wunner.de
State New
Headers show

Commit Message

Lukas Wunner Aug. 29, 2015, 12:29 p.m. UTC
This is not part of drm.tmpl as vga_switcheroo is a subsystem of its own
which interfaces not just with DRM but also with multiplexer drivers,
ALSA and power management.

Requires Markdown support.

Signed-off-by: Lukas Wunner <lukas@wunner.de>
---
 Documentation/DocBook/Makefile            |  5 +-
 Documentation/DocBook/vga_switcheroo.tmpl | 92 +++++++++++++++++++++++++++++++
 2 files changed, 95 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/DocBook/vga_switcheroo.tmpl

Comments

Daniel Vetter Sept. 22, 2015, 8:38 a.m. UTC | #1
On Sat, Aug 29, 2015 at 02:29:03PM +0200, Lukas Wunner wrote:
> This is not part of drm.tmpl as vga_switcheroo is a subsystem of its own
> which interfaces not just with DRM but also with multiplexer drivers,
> ALSA and power management.

I still think this would be better served included in the DRM docbook,
simply because doing that will increase the changes it's read. And if the
audio folks want to, they can pull in the same text somewhere in the audio
docs too.

I merged patch 1 meanwhile, thanks.
-Daniel

> 
> Requires Markdown support.
> 
> Signed-off-by: Lukas Wunner <lukas@wunner.de>
> ---
>  Documentation/DocBook/Makefile            |  5 +-
>  Documentation/DocBook/vga_switcheroo.tmpl | 92 +++++++++++++++++++++++++++++++
>  2 files changed, 95 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/DocBook/vga_switcheroo.tmpl
> 
> diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
> index 8276944..4495b37 100644
> --- a/Documentation/DocBook/Makefile
> +++ b/Documentation/DocBook/Makefile
> @@ -15,9 +15,10 @@ DOCBOOKS := z8530book.xml device-drivers.xml \
>  	    80211.xml debugobjects.xml sh.xml regulator.xml \
>  	    alsa-driver-api.xml writing-an-alsa-driver.xml \
>  	    tracepoint.xml drm.xml media_api.xml w1.xml \
> -	    writing_musb_glue_layer.xml crypto-API.xml
> +	    writing_musb_glue_layer.xml crypto-API.xml \
> +	    vga_switcheroo.xml
>  
> -MARKDOWNREADY := 
> +MARKDOWNREADY := vga_switcheroo.xml
>  
>  include Documentation/DocBook/media/Makefile
>  
> diff --git a/Documentation/DocBook/vga_switcheroo.tmpl b/Documentation/DocBook/vga_switcheroo.tmpl
> new file mode 100644
> index 0000000..e6128e7
> --- /dev/null
> +++ b/Documentation/DocBook/vga_switcheroo.tmpl
> @@ -0,0 +1,92 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
> +	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
> +
> +<book id="vga_switcheroo">
> +  <bookinfo>
> +    <title>vga_switcheroo Subsystem Guide</title>
> +
> +    <authorgroup>
> +      <author>
> +	<firstname>Lukas</firstname>
> +	<surname>Wunner</surname>
> +	<contrib>Initial version</contrib>
> +	<affiliation>
> +	  <address>
> +	    <email>lukas@wunner.de</email>
> +	  </address>
> +	</affiliation>
> +      </author>
> +    </authorgroup>
> +
> +    <copyright>
> +      <year>2015</year>
> +      <holder>Lukas Wunner</holder>
> +    </copyright>
> +
> +    <legalnotice>
> +      <para>
> +	The contents of this file may be used under the terms of the GNU
> +	General Public License version 2 (the "GPL") as distributed in
> +	the kernel source COPYING file.
> +      </para>
> +    </legalnotice>
> +
> +    <revhistory>
> +      <!-- Put document revisions here, newest first. -->
> +      <revision>
> +	<revnumber>1.0</revnumber>
> +	<date>2015-08-29</date>
> +	<authorinitials>LW</authorinitials>
> +	<revremark>Initial version
> +	</revremark>
> +      </revision>
> +    </revhistory>
> +  </bookinfo>
> +
> +<toc></toc>
> +
> +  <chapter id="overview">
> +    <title>Overview</title>
> +!Pdrivers/gpu/vga/vga_switcheroo.c Overview
> +  </chapter>
> +
> +  <chapter id="modes_of_use">
> +    <title>Modes of Use</title>
> +  <sect1>
> +    <title>Manual switching and manual power control</title>
> +!Pdrivers/gpu/vga/vga_switcheroo.c Manual switching and manual power control
> +  </sect1>
> +  <sect1>
> +    <title>Driver power control</title>
> +!Pdrivers/gpu/vga/vga_switcheroo.c Driver power control
> +  </sect1>
> +  </chapter>
> +
> +  <chapter id="pubfunctions">
> +    <title>Public functions</title>
> +!Edrivers/gpu/vga/vga_switcheroo.c
> +  </chapter>
> +
> +  <chapter id="pubstructures">
> +    <title>Public structures</title>
> +!Finclude/linux/vga_switcheroo.h vga_switcheroo_handler
> +!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_ops
> +  </chapter>
> +
> +  <chapter id="pubconstants">
> +    <title>Public constants</title>
> +!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_id
> +!Finclude/linux/vga_switcheroo.h vga_switcheroo_state
> +  </chapter>
> +
> +  <chapter id="privstructures">
> +    <title>Private structures</title>
> +!Fdrivers/gpu/vga/vga_switcheroo.c vgasr_priv
> +!Fdrivers/gpu/vga/vga_switcheroo.c vga_switcheroo_client
> +  </chapter>
> +
> +!Cdrivers/gpu/vga/vga_switcheroo.c
> +!Cinclude/linux/vga_switcheroo.h
> +
> +</book>
> -- 
> 1.8.5.2 (Apple Git-48)
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel

Patch
diff mbox

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 8276944..4495b37 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -15,9 +15,10 @@  DOCBOOKS := z8530book.xml device-drivers.xml \
 	    80211.xml debugobjects.xml sh.xml regulator.xml \
 	    alsa-driver-api.xml writing-an-alsa-driver.xml \
 	    tracepoint.xml drm.xml media_api.xml w1.xml \
-	    writing_musb_glue_layer.xml crypto-API.xml
+	    writing_musb_glue_layer.xml crypto-API.xml \
+	    vga_switcheroo.xml
 
-MARKDOWNREADY := 
+MARKDOWNREADY := vga_switcheroo.xml
 
 include Documentation/DocBook/media/Makefile
 
diff --git a/Documentation/DocBook/vga_switcheroo.tmpl b/Documentation/DocBook/vga_switcheroo.tmpl
new file mode 100644
index 0000000..e6128e7
--- /dev/null
+++ b/Documentation/DocBook/vga_switcheroo.tmpl
@@ -0,0 +1,92 @@ 
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
+
+<book id="vga_switcheroo">
+  <bookinfo>
+    <title>vga_switcheroo Subsystem Guide</title>
+
+    <authorgroup>
+      <author>
+	<firstname>Lukas</firstname>
+	<surname>Wunner</surname>
+	<contrib>Initial version</contrib>
+	<affiliation>
+	  <address>
+	    <email>lukas@wunner.de</email>
+	  </address>
+	</affiliation>
+      </author>
+    </authorgroup>
+
+    <copyright>
+      <year>2015</year>
+      <holder>Lukas Wunner</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+	The contents of this file may be used under the terms of the GNU
+	General Public License version 2 (the "GPL") as distributed in
+	the kernel source COPYING file.
+      </para>
+    </legalnotice>
+
+    <revhistory>
+      <!-- Put document revisions here, newest first. -->
+      <revision>
+	<revnumber>1.0</revnumber>
+	<date>2015-08-29</date>
+	<authorinitials>LW</authorinitials>
+	<revremark>Initial version
+	</revremark>
+      </revision>
+    </revhistory>
+  </bookinfo>
+
+<toc></toc>
+
+  <chapter id="overview">
+    <title>Overview</title>
+!Pdrivers/gpu/vga/vga_switcheroo.c Overview
+  </chapter>
+
+  <chapter id="modes_of_use">
+    <title>Modes of Use</title>
+  <sect1>
+    <title>Manual switching and manual power control</title>
+!Pdrivers/gpu/vga/vga_switcheroo.c Manual switching and manual power control
+  </sect1>
+  <sect1>
+    <title>Driver power control</title>
+!Pdrivers/gpu/vga/vga_switcheroo.c Driver power control
+  </sect1>
+  </chapter>
+
+  <chapter id="pubfunctions">
+    <title>Public functions</title>
+!Edrivers/gpu/vga/vga_switcheroo.c
+  </chapter>
+
+  <chapter id="pubstructures">
+    <title>Public structures</title>
+!Finclude/linux/vga_switcheroo.h vga_switcheroo_handler
+!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_ops
+  </chapter>
+
+  <chapter id="pubconstants">
+    <title>Public constants</title>
+!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_id
+!Finclude/linux/vga_switcheroo.h vga_switcheroo_state
+  </chapter>
+
+  <chapter id="privstructures">
+    <title>Private structures</title>
+!Fdrivers/gpu/vga/vga_switcheroo.c vgasr_priv
+!Fdrivers/gpu/vga/vga_switcheroo.c vga_switcheroo_client
+  </chapter>
+
+!Cdrivers/gpu/vga/vga_switcheroo.c
+!Cinclude/linux/vga_switcheroo.h
+
+</book>