[PATCH] vga_switcheroo: Sphinxify docs

[Daniel Vetter]

On Mon, Jul 11, 2016 at 10:22:33AM +0200, Lukas Wunner wrote:
> Fix up formatting glitches remaining after the automatic rst conversion.
> 
> Cc: Jonathan Corbet <corbet at lwn.net>
> Cc: Jani Nikula <jani.nikula at intel.com>
> Signed-off-by: Lukas Wunner <lukas at wunner.de>

\o/ for doc patches! Applied to drm-misc, thanks.
-Daniel

> ---
>  Documentation/gpu/drm-internals.rst  |  4 ++--
>  Documentation/gpu/vga-switcheroo.rst |  8 ++------
>  drivers/gpu/vga/vga_switcheroo.c     | 28 ++++++++++++++--------------
>  3 files changed, 18 insertions(+), 22 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-internals.rst b/Documentation/gpu/drm-internals.rst
> index 4f71765..490d655 100644
> --- a/Documentation/gpu/drm-internals.rst
> +++ b/Documentation/gpu/drm-internals.rst
> @@ -280,8 +280,8 @@ private data in the open method should free it here.
>  The lastclose method should restore CRTC and plane properties to default
>  value, so that a subsequent open of the device will not inherit state
>  from the previous user. It can also be used to execute delayed power
> -switching state changes, e.g. in conjunction with the vga_switcheroo
> -infrastructure (see ?). Beyond that KMS drivers should not do any
> +switching state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
> +infrastructure. Beyond that KMS drivers should not do any
>  further cleanup. Only legacy UMS drivers might need to clean up device
>  state so that the vga console or an independent fbdev driver could take
>  over.
> diff --git a/Documentation/gpu/vga-switcheroo.rst b/Documentation/gpu/vga-switcheroo.rst
> index 327d930..cbbdb99 100644
> --- a/Documentation/gpu/vga-switcheroo.rst
> +++ b/Documentation/gpu/vga-switcheroo.rst
> @@ -1,3 +1,5 @@
> +.. _vga_switcheroo:
> +
>  ==============
>  VGA Switcheroo
>  ==============
> @@ -94,9 +96,3 @@ Public functions
>  
>  .. kernel-doc:: include/linux/apple-gmux.h
>     :internal:
> -
> -.. WARNING: DOCPROC directive not supported: !Cdrivers/gpu/vga/vga_switcheroo.c
> -
> -.. WARNING: DOCPROC directive not supported: !Cinclude/linux/vga_switcheroo.h
> -
> -.. WARNING: DOCPROC directive not supported: !Cdrivers/platform/x86/apple-gmux.c
> diff --git a/drivers/gpu/vga/vga_switcheroo.c b/drivers/gpu/vga/vga_switcheroo.c
> index 2df216b3..5f962bf 100644
> --- a/drivers/gpu/vga/vga_switcheroo.c
> +++ b/drivers/gpu/vga/vga_switcheroo.c
> @@ -52,9 +52,9 @@
>   *
>   * * muxed: Dual GPUs with a multiplexer chip to switch outputs between GPUs.
>   * * muxless: Dual GPUs but only one of them is connected to outputs.
> - * 	The other one is merely used to offload rendering, its results
> - * 	are copied over PCIe into the framebuffer. On Linux this is
> - * 	supported with DRI PRIME.
> + *   The other one is merely used to offload rendering, its results
> + *   are copied over PCIe into the framebuffer. On Linux this is
> + *   supported with DRI PRIME.
>   *
>   * Hybrid graphics started to appear in the late Naughties and were initially
>   * all muxed. Newer laptops moved to a muxless architecture for cost reasons.
> @@ -560,21 +560,21 @@ EXPORT_SYMBOL(vga_switcheroo_unlock_ddc);
>   * * OFF: Power off the device not in use.
>   * * ON: Power on the device not in use.
>   * * IGD: Switch to the integrated graphics device.
> - * 	Power on the integrated GPU if necessary, power off the discrete GPU.
> - * 	Prerequisite is that no user space processes (e.g. Xorg, alsactl)
> - * 	have opened device files of the GPUs or the audio client. If the
> - * 	switch fails, the user may invoke lsof(8) or fuser(1) on /dev/dri/
> - * 	and /dev/snd/controlC1 to identify processes blocking the switch.
> + *   Power on the integrated GPU if necessary, power off the discrete GPU.
> + *   Prerequisite is that no user space processes (e.g. Xorg, alsactl)
> + *   have opened device files of the GPUs or the audio client. If the
> + *   switch fails, the user may invoke lsof(8) or fuser(1) on /dev/dri/
> + *   and /dev/snd/controlC1 to identify processes blocking the switch.
>   * * DIS: Switch to the discrete graphics device.
>   * * DIGD: Delayed switch to the integrated graphics device.
> - * 	This will perform the switch once the last user space process has
> - * 	closed the device files of the GPUs and the audio client.
> + *   This will perform the switch once the last user space process has
> + *   closed the device files of the GPUs and the audio client.
>   * * DDIS: Delayed switch to the discrete graphics device.
>   * * MIGD: Mux-only switch to the integrated graphics device.
> - * 	Does not remap console or change the power state of either gpu.
> - * 	If the integrated GPU is currently off, the screen will turn black.
> - * 	If it is on, the screen will show whatever happens to be in VRAM.
> - * 	Either way, the user has to blindly enter the command to switch back.
> + *   Does not remap console or change the power state of either gpu.
> + *   If the integrated GPU is currently off, the screen will turn black.
> + *   If it is on, the screen will show whatever happens to be in VRAM.
> + *   Either way, the user has to blindly enter the command to switch back.
>   * * MDIS: Mux-only switch to the discrete graphics device.
>   *
>   * For GPUs whose power state is controlled by the driver's runtime pm,
> -- 
> 2.8.1
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

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