Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
* [alsa-devel] [PATCH] ALSA: doc: fix snd_hda_intel driver name
@ 2020-02-13 10:36 Radoslaw Smigielski
  2020-02-13 10:58 ` Takashi Iwai
  0 siblings, 1 reply; 4+ messages in thread
From: Radoslaw Smigielski @ 2020-02-13 10:36 UTC (permalink / raw)
  To: linux-kernel, linux-doc, alsa-devel, corbet, tiwai, perex,
	radoslaw.smigielski

Update driver name snd-hda-intel to proper, existing driver
name snd_hda_intel in Documentation/sound/hd-audio/notes.rst.

Signed-off-by: Radoslaw Smigielski <radoslaw.smigielski@interia.pl>
---
 Documentation/sound/hd-audio/notes.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/sound/hd-audio/notes.rst b/Documentation/sound/hd-audio/notes.rst
index 0f3109d9abc8..56ccc15f4d26 100644
--- a/Documentation/sound/hd-audio/notes.rst
+++ b/Documentation/sound/hd-audio/notes.rst
@@ -17,12 +17,12 @@ methods for the	HD-audio hardware.
 
 The HD-audio component consists of two parts: the controller chip and 
 the codec chips on the HD-audio bus.  Linux provides a single driver
-for all controllers, snd-hda-intel.  Although the driver name contains
+for all controllers, snd_hda_intel.  Although the driver name contains
 a word of a well-known hardware vendor, it's not specific to it but for
 all controller chips by other companies.  Since the HD-audio
 controllers are supposed to be compatible, the single snd-hda-driver
 should work in most cases.  But, not surprisingly, there are known
-bugs and issues specific to each controller type.  The snd-hda-intel
+bugs and issues specific to each controller type.  The snd_hda_intel
 driver has a bunch of workarounds for these as described below.
 
 A controller may have multiple codecs.  Usually you have one audio
@@ -31,7 +31,7 @@ multiple audio codecs, e.g. for analog and digital outputs, and the
 driver might not work properly because of conflict of mixer elements.
 This should be fixed in future if such hardware really exists.
 
-The snd-hda-intel driver has several different codec parsers depending
+The snd_hda_intel driver has several different codec parsers depending
 on the codec.  It has a generic parser as a fallback, but this
 functionality is fairly limited until now.  Instead of the generic
 parser, usually the codec-specific parser (coded in patch_*.c) is used
@@ -226,7 +226,7 @@ the external amplifier bits.  Thus a headphone output has a slightly
 better chance.
 
 Before making a bug report, double-check whether the mixer is set up
-correctly.  The recent version of snd-hda-intel driver provides mostly
+correctly.  The recent version of snd_hda_intel driver provides mostly
 "Master" volume control as well as "Front" volume (where Front
 indicates the front-channels).  In addition, there can be individual
 "Headphone" and "Speaker" controls.
@@ -596,7 +596,7 @@ For example, if you have two cards, one for an on-board analog and one
 for an HDMI video board, you may pass patch option like below:
 ::
 
-    options snd-hda-intel patch=on-board-patch,hdmi-patch
+    options snd_hda_intel patch=on-board-patch,hdmi-patch
 
 
 Power-Saving
-- 
2.24.1


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [alsa-devel] [PATCH] ALSA: doc: fix snd_hda_intel driver name
  2020-02-13 10:36 [alsa-devel] [PATCH] ALSA: doc: fix snd_hda_intel driver name Radoslaw Smigielski
@ 2020-02-13 10:58 ` Takashi Iwai
  2020-02-13 11:43   ` Radoslaw Smigielski
  0 siblings, 1 reply; 4+ messages in thread
From: Takashi Iwai @ 2020-02-13 10:58 UTC (permalink / raw)
  To: Radoslaw Smigielski
  Cc: linux-kernel, linux-doc, alsa-devel, corbet, tiwai, perex

On Thu, 13 Feb 2020 11:36:37 +0100,
Radoslaw Smigielski wrote:
> 
> Update driver name snd-hda-intel to proper, existing driver
> name snd_hda_intel in Documentation/sound/hd-audio/notes.rst.

snd-hda-intel is correct from the module file name POV.
Both are handled equivalently.


thanks,

Takashi

> 
> Signed-off-by: Radoslaw Smigielski <radoslaw.smigielski@interia.pl>
> ---
>  Documentation/sound/hd-audio/notes.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/sound/hd-audio/notes.rst b/Documentation/sound/hd-audio/notes.rst
> index 0f3109d9abc8..56ccc15f4d26 100644
> --- a/Documentation/sound/hd-audio/notes.rst
> +++ b/Documentation/sound/hd-audio/notes.rst
> @@ -17,12 +17,12 @@ methods for the	HD-audio hardware.
>  
>  The HD-audio component consists of two parts: the controller chip and 
>  the codec chips on the HD-audio bus.  Linux provides a single driver
> -for all controllers, snd-hda-intel.  Although the driver name contains
> +for all controllers, snd_hda_intel.  Although the driver name contains
>  a word of a well-known hardware vendor, it's not specific to it but for
>  all controller chips by other companies.  Since the HD-audio
>  controllers are supposed to be compatible, the single snd-hda-driver
>  should work in most cases.  But, not surprisingly, there are known
> -bugs and issues specific to each controller type.  The snd-hda-intel
> +bugs and issues specific to each controller type.  The snd_hda_intel
>  driver has a bunch of workarounds for these as described below.
>  
>  A controller may have multiple codecs.  Usually you have one audio
> @@ -31,7 +31,7 @@ multiple audio codecs, e.g. for analog and digital outputs, and the
>  driver might not work properly because of conflict of mixer elements.
>  This should be fixed in future if such hardware really exists.
>  
> -The snd-hda-intel driver has several different codec parsers depending
> +The snd_hda_intel driver has several different codec parsers depending
>  on the codec.  It has a generic parser as a fallback, but this
>  functionality is fairly limited until now.  Instead of the generic
>  parser, usually the codec-specific parser (coded in patch_*.c) is used
> @@ -226,7 +226,7 @@ the external amplifier bits.  Thus a headphone output has a slightly
>  better chance.
>  
>  Before making a bug report, double-check whether the mixer is set up
> -correctly.  The recent version of snd-hda-intel driver provides mostly
> +correctly.  The recent version of snd_hda_intel driver provides mostly
>  "Master" volume control as well as "Front" volume (where Front
>  indicates the front-channels).  In addition, there can be individual
>  "Headphone" and "Speaker" controls.
> @@ -596,7 +596,7 @@ For example, if you have two cards, one for an on-board analog and one
>  for an HDMI video board, you may pass patch option like below:
>  ::
>  
> -    options snd-hda-intel patch=on-board-patch,hdmi-patch
> +    options snd_hda_intel patch=on-board-patch,hdmi-patch
>  
>  
>  Power-Saving
> -- 
> 2.24.1
> 

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [alsa-devel] [PATCH] ALSA: doc: fix snd_hda_intel driver name
  2020-02-13 10:58 ` Takashi Iwai
@ 2020-02-13 11:43   ` Radoslaw Smigielski
  2020-02-13 11:46     ` Takashi Iwai
  0 siblings, 1 reply; 4+ messages in thread
From: Radoslaw Smigielski @ 2020-02-13 11:43 UTC (permalink / raw)
  To: Takashi Iwai
  Cc: perex, tiwai, corbet, radoslaw.smigielski, alsa-devel, linux-doc,
	linux-kernel

On Thu, Feb 13, 2020 at 11:58:04AM +0100, Takashi Iwai wrote:
> On Thu, 13 Feb 2020 11:36:37 +0100,
> Radoslaw Smigielski wrote:
> > 
> > Update driver name snd-hda-intel to proper, existing driver
> > name snd_hda_intel in Documentation/sound/hd-audio/notes.rst.
> 
> snd-hda-intel is correct from the module file name POV.
> Both are handled equivalently.
> 
> 
> thanks,
> 
> Takashi
> 

Takashi-san, I agree that the names with hyphens (snd-hda-intel)
are present in help sections of many options in sound/pci/hda/Kconfig.
But snd-hda-intel is confusing from end user point of view.
After reading notes.rst, end user is going to do someting like this:

    lsmod | grep snd-hda-intel

and this command gives false result.

Also this modprobe.conf file is not going to work but it's an existing
example in Documentation/sound/hd-audio/notes.rst:

> > -    options snd-hda-intel patch=on-board-patch,hdmi-patch


Cheers,
Radek

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [alsa-devel] [PATCH] ALSA: doc: fix snd_hda_intel driver name
  2020-02-13 11:43   ` Radoslaw Smigielski
@ 2020-02-13 11:46     ` Takashi Iwai
  0 siblings, 0 replies; 4+ messages in thread
From: Takashi Iwai @ 2020-02-13 11:46 UTC (permalink / raw)
  To: Radoslaw Smigielski
  Cc: perex, tiwai, corbet, alsa-devel, linux-doc, linux-kernel

On Thu, 13 Feb 2020 12:43:52 +0100,
Radoslaw Smigielski wrote:
> 
> On Thu, Feb 13, 2020 at 11:58:04AM +0100, Takashi Iwai wrote:
> > On Thu, 13 Feb 2020 11:36:37 +0100,
> > Radoslaw Smigielski wrote:
> > > 
> > > Update driver name snd-hda-intel to proper, existing driver
> > > name snd_hda_intel in Documentation/sound/hd-audio/notes.rst.
> > 
> > snd-hda-intel is correct from the module file name POV.
> > Both are handled equivalently.
> > 
> > 
> > thanks,
> > 
> > Takashi
> > 
> 
> Takashi-san, I agree that the names with hyphens (snd-hda-intel)
> are present in help sections of many options in sound/pci/hda/Kconfig.
> But snd-hda-intel is confusing from end user point of view.
> After reading notes.rst, end user is going to do someting like this:
> 
>     lsmod | grep snd-hda-intel
> 
> and this command gives false result.
> 
> Also this modprobe.conf file is not going to work

It must work.  If not, it's a bug of modprobe :)


Takashi


> but it's an existing
> example in Documentation/sound/hd-audio/notes.rst:
> 
> > > -    options snd-hda-intel patch=on-board-patch,hdmi-patch
> 
> 
> Cheers,
> Radek
> 

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, back to index

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-13 10:36 [alsa-devel] [PATCH] ALSA: doc: fix snd_hda_intel driver name Radoslaw Smigielski
2020-02-13 10:58 ` Takashi Iwai
2020-02-13 11:43   ` Radoslaw Smigielski
2020-02-13 11:46     ` Takashi Iwai

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git