[alsa-devel] [PATCH 3/8] Documentation: fix input related doc refs

[Takashi Iwai]

On Tue, 10 Oct 2017 19:36:23 +0200,
Tom Saeger wrote:
> 
> Make `input` document refs valid including:
>   - joystick
>   - joystick-parport
> 
> Signed-off-by: Tom Saeger <tom.saeger at oracle.com>

For the sound part:
Reviewed-by: Takashi Iwai <tiwai at suse.de>


thanks,

Takashi

> ---
>  Documentation/admin-guide/kernel-parameters.txt | 10 +++++-----
>  Documentation/hid/hiddev.txt                    |  2 +-
>  Documentation/input/devices/xpad.rst            |  3 ++-
>  Documentation/sound/cards/joystick.rst          |  2 +-
>  4 files changed, 9 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index e857bbbc8575..411b41127eee 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -314,7 +314,7 @@
>  	amijoy.map=	[HW,JOY] Amiga joystick support
>  			Map of devices attached to JOY0DAT and JOY1DAT
>  			Format: <a>,<b>
> -			See also Documentation/input/joystick.txt
> +			See also Documentation/input/joydev/joystick.rst
>  
>  	analog.map=	[HW,JOY] Analog joystick and gamepad support
>  			Specifies type or capabilities of an analog joystick
> @@ -724,7 +724,7 @@
>  	db9.dev[2|3]=	[HW,JOY] Multisystem joystick support via parallel port
>  			(one device per port)
>  			Format: <port#>,<type>
> -			See also Documentation/input/joystick-parport.txt
> +			See also Documentation/input/devices/joystick-parport.rst
>  
>  	ddebug_query=   [KNL,DYNAMIC_DEBUG] Enable debug messages at early boot
>  			time. See
> @@ -1220,7 +1220,7 @@
>  			[HW,JOY] Multisystem joystick and NES/SNES/PSX pad
>  			support via parallel port (up to 5 devices per port)
>  			Format: <port#>,<pad1>,<pad2>,<pad3>,<pad4>,<pad5>
> -			See also Documentation/input/joystick-parport.txt
> +			See also Documentation/input/devices/joystick-parport.rst
>  
>  	gamma=		[HW,DRM]
>  
> @@ -1766,7 +1766,7 @@
>  				ivrs_acpihid[00:14.5]=AMD0020:0
>  
>  	js=		[HW,JOY] Analog joystick
> -			See Documentation/input/joystick.txt.
> +			See Documentation/input/joydev/joystick.rst.
>  
>  	nokaslr		[KNL]
>  			When CONFIG_RANDOMIZE_BASE is set, this disables
> @@ -4199,7 +4199,7 @@
>  			TurboGraFX parallel port interface
>  			Format:
>  			<port#>,<js1>,<js2>,<js3>,<js4>,<js5>,<js6>,<js7>
> -			See also Documentation/input/joystick-parport.txt
> +			See also Documentation/input/devices/joystick-parport.rst
>  
>  	udbg-immortal	[PPC] When debugging early kernel crashes that
>  			happen after console_init() and before a proper
> diff --git a/Documentation/hid/hiddev.txt b/Documentation/hid/hiddev.txt
> index 6e8c9f1d2f22..638448707aa2 100644
> --- a/Documentation/hid/hiddev.txt
> +++ b/Documentation/hid/hiddev.txt
> @@ -12,7 +12,7 @@ To support these disparate requirements, the Linux USB system provides
>  HID events to two separate interfaces:
>  * the input subsystem, which converts HID events into normal input
>  device interfaces (such as keyboard, mouse and joystick) and a
> -normalised event interface - see Documentation/input/input.txt
> +normalised event interface - see Documentation/input/input.rst
>  * the hiddev interface, which provides fairly raw HID events
>  
>  The data flow for a HID event produced by a device is something like
> diff --git a/Documentation/input/devices/xpad.rst b/Documentation/input/devices/xpad.rst
> index 5a709ab77c8d..b8bd65962dd8 100644
> --- a/Documentation/input/devices/xpad.rst
> +++ b/Documentation/input/devices/xpad.rst
> @@ -230,4 +230,5 @@ Historic Edits
>  2005-03-19 - Dominic Cerquetti <binary1230 at yahoo.com>
>   - added stuff for dance pads, new d-pad->axes mappings
>  
> -Later changes may be viewed with 'git log Documentation/input/xpad.txt'
> +Later changes may be viewed with
> +'git log --follow Documentation/input/devices/xpad.rst'
> diff --git a/Documentation/sound/cards/joystick.rst b/Documentation/sound/cards/joystick.rst
> index a6e468c81d02..488946fc1079 100644
> --- a/Documentation/sound/cards/joystick.rst
> +++ b/Documentation/sound/cards/joystick.rst
> @@ -11,7 +11,7 @@ General
>  
>  First of all, you need to enable GAMEPORT support on Linux kernel for
>  using a joystick with the ALSA driver.  For the details of gameport
> -support, refer to Documentation/input/joystick.txt.
> +support, refer to Documentation/input/joydev/joystick.rst.
>  
>  The joystick support of ALSA drivers is different between ISA and PCI
>  cards.  In the case of ISA (PnP) cards, it's usually handled by the
> -- 
> 2.14.2
> 
>