Commit 3a848662 authored by Lukas Wunner's avatar Lukas Wunner Committed by Daniel Vetter

vga_switcheroo: Prettify documentation

Fix indentation of vga_switcheroo sections in gpu.tmpl.

Change section type of API documentation from "chapter" to "sect1"
so that the individual functions no longer clutter up the ToC.
Group together under a new "API" chapter.

Fix wording "heretoforth" -> "henceforth".
Signed-off-by: default avatarLukas Wunner <lukas@wunner.de>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
parent 69a0f89c
...@@ -3625,37 +3625,37 @@ int num_ioctls;</synopsis> ...@@ -3625,37 +3625,37 @@ int num_ioctls;</synopsis>
<chapter id="modes_of_use"> <chapter id="modes_of_use">
<title>Modes of Use</title> <title>Modes of Use</title>
<sect1> <sect1>
<title>Manual switching and manual power control</title> <title>Manual switching and manual power control</title>
!Pdrivers/gpu/vga/vga_switcheroo.c Manual switching and manual power control !Pdrivers/gpu/vga/vga_switcheroo.c Manual switching and manual power control
</sect1> </sect1>
<sect1> <sect1>
<title>Driver power control</title> <title>Driver power control</title>
!Pdrivers/gpu/vga/vga_switcheroo.c Driver power control !Pdrivers/gpu/vga/vga_switcheroo.c Driver power control
</sect1> </sect1>
</chapter> </chapter>
<chapter id="pubfunctions"> <chapter id="api">
<title>Public functions</title> <title>API</title>
<sect1>
<title>Public functions</title>
!Edrivers/gpu/vga/vga_switcheroo.c !Edrivers/gpu/vga/vga_switcheroo.c
</chapter> </sect1>
<sect1>
<chapter id="pubstructures"> <title>Public structures</title>
<title>Public structures</title>
!Finclude/linux/vga_switcheroo.h vga_switcheroo_handler !Finclude/linux/vga_switcheroo.h vga_switcheroo_handler
!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_ops !Finclude/linux/vga_switcheroo.h vga_switcheroo_client_ops
</chapter> </sect1>
<sect1>
<chapter id="pubconstants"> <title>Public constants</title>
<title>Public constants</title>
!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_id !Finclude/linux/vga_switcheroo.h vga_switcheroo_client_id
!Finclude/linux/vga_switcheroo.h vga_switcheroo_state !Finclude/linux/vga_switcheroo.h vga_switcheroo_state
</chapter> </sect1>
<sect1>
<chapter id="privstructures"> <title>Private structures</title>
<title>Private structures</title>
!Fdrivers/gpu/vga/vga_switcheroo.c vgasr_priv !Fdrivers/gpu/vga/vga_switcheroo.c vgasr_priv
!Fdrivers/gpu/vga/vga_switcheroo.c vga_switcheroo_client !Fdrivers/gpu/vga/vga_switcheroo.c vga_switcheroo_client
</sect1>
</chapter> </chapter>
!Cdrivers/gpu/vga/vga_switcheroo.c !Cdrivers/gpu/vga/vga_switcheroo.c
......
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
* for the inactive GPU.) Also, muxes are often used to cut power to the * for the inactive GPU.) Also, muxes are often used to cut power to the
* discrete GPU while it is not used. * discrete GPU while it is not used.
* *
* DRM drivers register GPUs with vga_switcheroo, these are heretoforth called * DRM drivers register GPUs with vga_switcheroo, these are henceforth called
* clients. The mux is called the handler. Muxless machines also register a * clients. The mux is called the handler. Muxless machines also register a
* handler to control the power state of the discrete GPU, its ->switchto * handler to control the power state of the discrete GPU, its ->switchto
* callback is a no-op for obvious reasons. The discrete GPU is often equipped * callback is a no-op for obvious reasons. The discrete GPU is often equipped
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment