[PATCH] Documentation: Correct "dmascc=" to read "dmascc.io=".

[PATCH] Documentation: Correct "dmascc=" to read "dmascc.io=".

[Robert P. J. Day]

Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>

---

 Documentation/kernel-parameters.txt |    2 +-
 drivers/net/hamradio/Kconfig        |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index b41cde3..318b284 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -543,7 +543,7 @@ and is between 256 and 4096 characters. It is defined in the file
 			See drivers/char/README.epca and
 			Documentation/digiepca.txt.

-	dmascc=		[HW,AX25,SERIAL] AX.25 Z80SCC driver with DMA
+	dmascc.io=	[HW,AX25,SERIAL] AX.25 Z80SCC driver with DMA
 			support available.
 			Format: <io_dev0>[,<io_dev1>[,..<io_dev32>]]

diff --git a/drivers/net/hamradio/Kconfig b/drivers/net/hamradio/Kconfig
index 36d2c7d..62d5d5c 100644
--- a/drivers/net/hamradio/Kconfig
+++ b/drivers/net/hamradio/Kconfig
@@ -64,7 +64,7 @@ config DMASCC
 	  dmascc. If you don't pass any parameter to the driver, all
 	  possible I/O addresses are probed. This could irritate other devices
 	  that are currently not in use. You may specify the list of addresses
-	  to be probed by "dmascc­dr1,addr2,..." (when compiled into the
+	  to be probed by "dmascc.io­dr1,addr2,..." (when compiled into the
 	  kernel image) or "io­dr1,addr2,..." (when loaded as a module). The
 	  network interfaces will be called dmascc0 and dmascc1 for the board
 	  detected first, dmascc2 and dmascc3 for the second one, and so on.

-- 
====================================
Robert P. J. Day
Linux Consulting, Training and Annoying Kernel Pedantry
Waterloo, Ontario, CANADA

http://crashcourse.ca
====================================
-
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] Documentation: Correct "dmascc=" to read "dmascc.io=".

[Matthew Wilcox]

On Sun, Sep 09, 2007 at 02:19:44AM -0400, Robert P. J. Day wrote:
> diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> index b41cde3..318b284 100644
> --- a/Documentation/kernel-parameters.txt
> +++ b/Documentation/kernel-parameters.txt
> @@ -543,7 +543,7 @@ and is between 256 and 4096 characters. It is defined in the file
>  			See drivers/char/README.epca and
>  			Documentation/digiepca.txt.
> 
> -	dmascc=		[HW,AX25,SERIAL] AX.25 Z80SCC driver with DMA
> +	dmascc.io=	[HW,AX25,SERIAL] AX.25 Z80SCC driver with DMA
>  			support available.
>  			Format: <io_dev0>[,<io_dev1>[,..<io_dev32>]]
> 

It's not clear to me that this should be mentioned in
kernel-parameters.txt.  Many, many drivers have options which could be
mentioned in kernel-parameters.txt, and yet are not.

> diff --git a/drivers/net/hamradio/Kconfig b/drivers/net/hamradio/Kconfig
> index 36d2c7d..62d5d5c 100644
> --- a/drivers/net/hamradio/Kconfig
> +++ b/drivers/net/hamradio/Kconfig
> @@ -64,7 +64,7 @@ config DMASCC
>  	  dmascc. If you don't pass any parameter to the driver, all
>  	  possible I/O addresses are probed. This could irritate other devices
>  	  that are currently not in use. You may specify the list of addresses
> -	  to be probed by "dmascc­dr1,addr2,..." (when compiled into the
> +	  to be probed by "dmascc.io­dr1,addr2,..." (when compiled into the
>  	  kernel image) or "io­dr1,addr2,..." (when loaded as a module). The
>  	  network interfaces will be called dmascc0 and dmascc1 for the board
>  	  detected first, dmascc2 and dmascc3 for the second one, and so on.

Makes sense to mention it in the Kconfig text here though.

-- 
Intel are signing my paycheques ... these opinions are still mine
"Bill, look, we understand that you're interested in selling us this
operating system, but compare it to ours.  We can't possibly take such
a retrograde step."
-
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] Documentation: Correct "dmascc=" to read "dmascc.io=".

[Robert P. J. Day]

On Sun, 9 Sep 2007, Matthew Wilcox wrote:

> On Sun, Sep 09, 2007 at 02:19:44AM -0400, Robert P. J. Day wrote:
> > diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> > index b41cde3..318b284 100644
> > --- a/Documentation/kernel-parameters.txt
> > +++ b/Documentation/kernel-parameters.txt
> > @@ -543,7 +543,7 @@ and is between 256 and 4096 characters. It is defined in the file
> >  			See drivers/char/README.epca and
> >  			Documentation/digiepca.txt.
> >
> > -	dmascc=		[HW,AX25,SERIAL] AX.25 Z80SCC driver with DMA
> > +	dmascc.io=	[HW,AX25,SERIAL] AX.25 Z80SCC driver with DMA
> >  			support available.
> >  			Format: <io_dev0>[,<io_dev1>[,..<io_dev32>]]
> >
>
> It's not clear to me that this should be mentioned in
> kernel-parameters.txt.  Many, many drivers have options which could
> be mentioned in kernel-parameters.txt, and yet are not.

i agree absolutely.  i was just correcting an obvious mistake.
tossing it entirely from that file would suit me just as well.

> > diff --git a/drivers/net/hamradio/Kconfig b/drivers/net/hamradio/Kconfig
> > index 36d2c7d..62d5d5c 100644
> > --- a/drivers/net/hamradio/Kconfig
> > +++ b/drivers/net/hamradio/Kconfig
> > @@ -64,7 +64,7 @@ config DMASCC
> >  	  dmascc. If you don't pass any parameter to the driver, all
> >  	  possible I/O addresses are probed. This could irritate other devices
> >  	  that are currently not in use. You may specify the list of addresses
> > -	  to be probed by "dmascc­dr1,addr2,..." (when compiled into the
> > +	  to be probed by "dmascc.io­dr1,addr2,..." (when compiled into the
> >  	  kernel image) or "io­dr1,addr2,..." (when loaded as a module). The
> >  	  network interfaces will be called dmascc0 and dmascc1 for the board
> >  	  detected first, dmascc2 and dmascc3 for the second one, and so on.
>
> Makes sense to mention it in the Kconfig text here though.

again, agreed.

rday
-- 
====================================
Robert P. J. Day
Linux Consulting, Training and Annoying Kernel Pedantry
Waterloo, Ontario, CANADA

http://crashcourse.ca
====================================
-
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html