[PATCH] vga_switcheroo: Prettify documentation

[Daniel Vetter]

On Sat, Jan 02, 2016 at 06:47:17PM +0100, Lukas Wunner wrote:
> 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: Lukas Wunner <lukas at wunner.de>

Applied to drm-misc, thanks.
-Daniel

> ---
>  Documentation/DocBook/gpu.tmpl   | 40 ++++++++++++++++++++--------------------
>  drivers/gpu/vga/vga_switcheroo.c |  2 +-
>  2 files changed, 21 insertions(+), 21 deletions(-)
> 
> diff --git a/Documentation/DocBook/gpu.tmpl b/Documentation/DocBook/gpu.tmpl
> index f96a5d4..8e15980 100644
> --- a/Documentation/DocBook/gpu.tmpl
> +++ b/Documentation/DocBook/gpu.tmpl
> @@ -3631,37 +3631,37 @@ int num_ioctls;</synopsis>
>  
>    <chapter id="modes_of_use">
>      <title>Modes of Use</title>
> -  <sect1>
> -    <title>Manual switching and manual power control</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>
> +    </sect1>
> +    <sect1>
> +      <title>Driver power control</title>
>  !Pdrivers/gpu/vga/vga_switcheroo.c Driver power control
> -  </sect1>
> +    </sect1>
>    </chapter>
>  
> -  <chapter id="pubfunctions">
> -    <title>Public functions</title>
> +  <chapter id="api">
> +    <title>API</title>
> +    <sect1>
> +      <title>Public functions</title>
>  !Edrivers/gpu/vga/vga_switcheroo.c
> -  </chapter>
> -
> -  <chapter id="pubstructures">
> -    <title>Public structures</title>
> +    </sect1>
> +    <sect1>
> +      <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>
> +    </sect1>
> +    <sect1>
> +      <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>
> +    </sect1>
> +    <sect1>
> +      <title>Private structures</title>
>  !Fdrivers/gpu/vga/vga_switcheroo.c vgasr_priv
>  !Fdrivers/gpu/vga/vga_switcheroo.c vga_switcheroo_client
> +    </sect1>
>    </chapter>
>  
>  !Cdrivers/gpu/vga/vga_switcheroo.c
> diff --git a/drivers/gpu/vga/vga_switcheroo.c b/drivers/gpu/vga/vga_switcheroo.c
> index 41edd5a..d64d905 100644
> --- a/drivers/gpu/vga/vga_switcheroo.c
> +++ b/drivers/gpu/vga/vga_switcheroo.c
> @@ -63,7 +63,7 @@
>   * for the inactive GPU.) Also, muxes are often used to cut power to the
>   * 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
>   * 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
> -- 
> 1.8.5.2 (Apple Git-48)
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch