Skip to contentSkip to conversation

libata-sff: trivial corrections to Kconfig help text

PATCH Applied Stefan Richter 3 participants 7 messages May 29, 2010 – Jun 2, 2010 libata

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 libata-sff: trivial corrections to Kconfig help text

---
 drivers/ata/Kconfig |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
drivers/ata/Kconfig +3 -3
index 73f8833..aa85a98 100644
@@ -168,10 +168,10 @@ config ATA_BMDMA
 	default y
 	help
 	  This option adds support for SFF ATA controllers with BMDMA
-	  capability.  BMDMA stands for bus-master DMA and the
-	  de-facto DMA interface for SFF controllers.
+	  capability.  BMDMA stands for bus-master DMA and is the
+	  de facto DMA interface for SFF controllers.
 
-	  If unuser, say Y.
+	  If unsure, say Y.
 
 if ATA_BMDMA
 

By the way, is there something that could be said in a few words in the help text when to enable that option and when not?

Or could that option even be hidden and 'select'ed by bus master DMA capable ATA SFF drivers?

Signature · 3 lines
Stefan Richter
-=====-==-=- -=-= ===-=
http://arcgraph.de/sr/
Acked-by on v1 1/1
#1 lore raw
Quoted 1 line · Stefan Richter
Quoted 23 lines
---
 drivers/ata/Kconfig |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
drivers/ata/Kconfig +3 -3
index 73f8833..aa85a98 100644
@@ -168,10 +168,10 @@ config ATA_BMDMA
 	default y
 	help
 	  This option adds support for SFF ATA controllers with BMDMA
-	  capability.  BMDMA stands for bus-master DMA and the
-	  de-facto DMA interface for SFF controllers.
+	  capability.  BMDMA stands for bus-master DMA and is the
+	  de facto DMA interface for SFF controllers.
 
-	  If unuser, say Y.
+	  If unsure, say Y.
 
 if ATA_BMDMA
 
Quoted 2 lines

By the way, is there something that could be said in a few words in the help text when to enable that option and when not?

Hmmmm... maybe we can emphasize the 'if unsure, say Y' part?

Quoted 2 lines

Or could that option even be hidden and 'select'ed by bus master DMA capable ATA SFF drivers?

I wanted to make the distinction clear so made the option explicit. Opinions on whether that is actually a good idea would differ but at the same time, I don't think this would cause any problem, would it?

Thanks.

Signature · 1 line
tejun
#2 lore raw
Quoted 5 lines · Tejun Heo
Quoted 2 lines · Stefan Richter

By the way, is there something that could be said in a few words in the help text when to enable that option and when not?

Hmmmm... maybe we can emphasize the 'if unsure, say Y' part?

I did follow that recommendation but was still left curious. :-)

Quoted 6 lines
Quoted 2 lines

Or could that option even be hidden and 'select'ed by bus master DMA capable ATA SFF drivers?

I wanted to make the distinction clear so made the option explicit. Opinions on whether that is actually a good idea would differ but at the same time, I don't think this would cause any problem, would it?

OK, I first came across it by way of make oldconfig. Then I read the changelog and still wondered. Now I had a look at the menu layout in gconfig and it makes sense to me now.

Just from the looks of the menu, would calling the prompt

bool "SFF controllers with bus master DMA"

be sensible? After all, this option does not just control whether a certain capability is built into libata, switching it on pulls up the Kconfig prompts for a whole range of controller drivers. (Ok, the help text is saying exactly this, but then the prompt could do so already...)

The 'hidden variable + select' way would be more friendly to "make oldconfig", but I see now that it would take quite a few select statements to be added.

Signature · 3 lines
Stefan Richter
-=====-==-=- -=-= ===-=
http://arcgraph.de/sr/
#3 lore raw

Hello,

Quoted 3 lines · Stefan Richter
Quoted 1 line

Hmmmm... maybe we can emphasize the 'if unsure, say Y' part?

I did follow that recommendation but was still left curious. :-)

Maybe it should be changed to "You're supposed to be unsure, say Y, dammit!" :-)

Quoted 11 lines
Quoted 6 lines
Quoted 2 lines

Or could that option even be hidden and 'select'ed by bus master DMA capable ATA SFF drivers?

I wanted to make the distinction clear so made the option explicit. Opinions on whether that is actually a good idea would differ but at the same time, I don't think this would cause any problem, would it?

OK, I first came across it by way of make oldconfig. Then I read the changelog and still wondered. Now I had a look at the menu layout in gconfig and it makes sense to me now.

Quoted 8 lines

Just from the looks of the menu, would calling the prompt

bool "SFF controllers with bus master DMA"

be sensible? After all, this option does not just control whether a certain capability is built into libata, switching it on pulls up the Kconfig prompts for a whole range of controller drivers. (Ok, the help text is saying exactly this, but then the prompt could do so already...)

Yes, sure. Can you please combine this with the original patch?

Quoted 3 lines

The 'hidden variable + select' way would be more friendly to "make oldconfig", but I see now that it would take quite a few select statements to be added.

Yeah, that and I *really* wanted to make the distinction explicit because ambiguous dependeny has been a problem for some time. Now a driver will end up in a different config section which is always visible depending on its dependencies, so I like this much better.

Thanks.

Signature · 1 line
tejun
#4 lore raw

PATCH 1/1 libata-sff: clarification and trivial correction to Kconfig text

Change the text of the ATA_BMDMA prompt to indicate that it lets one access a class of device drivers (rather than only add a certain feature to libata). The divisions of the "ATA SFF support" menu now read
- SFF controllers with custom DMA interface,
- SFF controllers with bus master DMA (was: "ATA BMDMA support"),
- SATA SFF controllers with BMDMA,
- PATA SFF controllers with BMDMA,
- PIO-only SFF controllers.
This hopefully helps convince users of "make oldconfig" to follow the recommendation to switch that option on.

Also let the help text of this prompt say more precisely what it is about: It adds a little bit of support code to libata that is required by many but not all SFF drivers. This option alone does not add support of respective controllers though; according drivers are chosen at subsequent dependent Kconfig prompts. --- And fix a typo.

---
Supersedes patch "libata-sff: trivial corrections to Kconfig help text".

 drivers/ata/Kconfig |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)
drivers/ata/Kconfig +5 -5
index 73f8833..31e288b 100644
@@ -164,14 +164,14 @@ config SATA_SX4
 	  If unsure, say N.
 
 config ATA_BMDMA
-	bool "ATA BMDMA support"
+	bool "SFF controllers with bus master DMA"
 	default y
 	help
-	  This option adds support for SFF ATA controllers with BMDMA
-	  capability.  BMDMA stands for bus-master DMA and the
-	  de-facto DMA interface for SFF controllers.
+	  This option is required by drivers of SFF ATA controllers with
+	  BMDMA capability.  BMDMA stands for bus master DMA and is the
+	  de facto DMA interface for SFF controllers.
 
-	  If unuser, say Y.
+	  If unsure, say Y.
 
 if ATA_BMDMA
 
Signature · 3 lines
Stefan Richter
-=====-==-=- -=-= ====-
http://arcgraph.de/sr/
Acked-by on v1 1/1
#5 lore raw

Re: [PATCH] libata-sff: clarification and trivial correction to Kconfig text

Quoted 11 lines · Stefan Richter

Change the text of the ATA_BMDMA prompt to indicate that it lets one access a class of device drivers (rather than only add a certain feature to libata). The divisions of the "ATA SFF support" menu now read
- SFF controllers with custom DMA interface,
- SFF controllers with bus master DMA (was: "ATA BMDMA support"),
- SATA SFF controllers with BMDMA,
- PATA SFF controllers with BMDMA,
- PIO-only SFF controllers.
This hopefully helps convince users of "make oldconfig" to follow the recommendation to switch that option on.

Quoted 6 lines

Also let the help text of this prompt say more precisely what it is about: It adds a little bit of support code to libata that is required by many but not all SFF drivers. This option alone does not add support of respective controllers though; according drivers are chosen at subsequent dependent Kconfig prompts. --- And fix a typo.

Thanks.

Signature · 1 line
tejun
Applied
#6 lore raw
In reply to Stefan Richter
Quoted 12 lines · Stefan Richter
---
  drivers/ata/Kconfig |    6 +++---
  1 files changed, 3 insertions(+), 3 deletions(-)
drivers/ata/Kconfig +0 -0
index 73f8833..aa85a98 100644
@@ -168,10 +168,10 @@ config ATA_BMDMA
  	default y
  	help

drivers/ata/Kconfig config ATA_BMDMA · line 176

Quoted 10 lines
drivers/ata/Kconfig +3 -3
  	  This option adds support for SFF ATA controllers with BMDMA
-	  capability.  BMDMA stands for bus-master DMA and the
-	  de-facto DMA interface for SFF controllers.
+	  capability.  BMDMA stands for bus-master DMA and is the
+	  de facto DMA interface for SFF controllers.
 
-	  If unuser, say Y.
+	  If unsure, say Y.
 
  if ATA_BMDMA

applied