Skip to contentSkip to conversation

staging: r8188eu: default to "y" in Kconfig

PATCH In review Paul Bolle 7 participants 16 messages Feb 11, 2014 – Oct 29, 2014

Subsystems (2)
lore
Share & tools
lore

Paul Bolle

author
#0 lore raw

PATCH 1/1 staging: r8188eu: default to "y" in Kconfig

Two Kconfig entries for this driver default to (uppercase) "Y". But in Kconfig (lowercase) "y" is a magic symbol. "Y" is an ordinary symbol. As "Y" is never set these Kconfig symbols will also not be set by default.

So use "default y" here, as was clearly intended.

---
This patch will enable code that used to be disabled. Since this is in staging, that should be OK. This might also uncover warnings or errors. I didn't test it, anyhow.

This patch also deserves a

line, but that apparently requires Martin's permission.

 drivers/staging/rtl8188eu/Kconfig | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/rtl8188eu/Kconfig +2 -2
index c9c548f..9a57d31 100644
@@ -12,7 +12,7 @@ if R8188EU
 
 config 88EU_AP_MODE
 	bool "Realtek RTL8188EU AP mode"
-	default Y
+	default y
 	---help---
 	This option enables Access Point mode. Unless you know that your system
 	will never be used as an AP, or the target system has limited memory,
@@ -20,7 +20,7 @@ config 88EU_AP_MODE
 
 config 88EU_P2P
 	bool "Realtek RTL8188EU Peer-to-peer mode"
-	default Y
+	default y
 	---help---
 	This option enables peer-to-peer mode for the r8188eu driver. Unless you
 	know that peer-to-peer (P2P) mode will never be used, or the target system has
Signature · 1 line
1.8.5.3
#1 lore raw
Quoted 13 lines · Paul Bolle

Two Kconfig entries for this driver default to (uppercase) "Y". But in Kconfig (lowercase) "y" is a magic symbol. "Y" is an ordinary symbol. As "Y" is never set these Kconfig symbols will also not be set by default.

So use "default y" here, as was clearly intended.

---
This patch will enable code that used to be disabled. Since this is in staging, that should be OK. This might also uncover warnings or errors. I didn't test it, anyhow.

Quoted 5 lines

This patch also deserves a

line, but that apparently requires Martin's permission.

You've pretty much given Martin's secret assistance away already on a public mailing list. Next time just add the Reported-by. :P

regards,
dan carpenter

author
#2 lore raw
Quoted 2 lines · Dan Carpenter

You've pretty much given Martin's secret assistance away already on a public mailing list. Next time just add the Reported-by. :P

I would have done, if I hadn't bothered to check Documentation/SubmittingPatches first. It contains:
Please note that this tag should not be added without the reporter's permission, especially if the problem was not reported in a public forum.

Perhaps that should read:
[...], unless the problem was reported in a public forum.

Paul Bolle

#3 lore raw
Quoted 4 lines · Paul Bolle
Quoted 2 lines · Dan Carpenter

You've pretty much given Martin's secret assistance away already on a public mailing list. Next time just add the Reported-by. :P

Quoted 8 lines

I would have done, if I hadn't bothered to check Documentation/SubmittingPatches first. It contains:
Please note that this tag should not be added without the reporter's permission, especially if the problem was not reported in a public forum.

Perhaps that should read:
[...], unless the problem was reported in a public forum.

Or maybe:

Please note that if the problem was reported in private then you should ask for permission before adding a Reported-by tag.

regards,
dan carpenter

author
#4 lore raw
Quoted 7 lines · Dan Carpenter
Quoted 6 lines · Paul Bolle

I would have done, if I hadn't bothered to check Documentation/SubmittingPatches first. It contains:
Please note that this tag should not be added without the reporter's permission, especially if the problem was not reported in a public forum.

Quoted 7 lines
Quoted 2 lines

Perhaps that should read:
[...], unless the problem was reported in a public forum.

Or maybe:

Please note that if the problem was reported in private then you should ask for permission before adding a Reported-by tag.

Your suggestion is clear and to the point. Care to submit a patch? That also gives you a chance to mock my reading of the current text.

Paul Bolle

#5 lore raw

PATCH 1/1 Documentation/SubmittingPatches: Reported-by tags and permission

The reported-by text says you have to ask for permission, but that's only if the bug was reported in private. These days the standard is to always give reported-by credit or it's considered a bit rude.

Documentation/SubmittingPatches +3 -6
index 26b1e31d5a13..f72ce7803b71 100644
@@ -432,12 +432,9 @@ have been included in the discussion
 
 14) Using Reported-by:, Tested-by:, Reviewed-by: and Suggested-by:
 
-If this patch fixes a problem reported by somebody else, consider adding a
-Reported-by: tag to credit the reporter for their contribution.  Please
-note that this tag should not be added without the reporter's permission,
-especially if the problem was not reported in a public forum.  That said,
-if we diligently credit our bug reporters, they will, hopefully, be
-inspired to help us again in the future.
+The Reported-by tag is to give credit to people who find bugs and report them.
+Please note that if the bug was reported in private, then ask for permission
+first before using the Reported-by tag.
 
 A Tested-by: tag indicates that the patch has been successfully tested (in
 some environment) by the person named.  This tag informs maintainers that
reviewer Acked-by on v1 1/1
#6 lore raw

Re: [patch] Documentation/SubmittingPatches: Reported-by tags and permission

Quoted 5 lines · Dan Carpenter

The reported-by text says you have to ask for permission, but that's only if the bug was reported in private. These days the standard is to always give reported-by credit or it's considered a bit rude.

Thanks.

Quoted 21 lines
Documentation/SubmittingPatches +3 -7
index 26b1e31d5a13..f72ce7803b71 100644
@@ -432,12 +432,9 @@ have been included in the discussion
 
 14) Using Reported-by:, Tested-by:, Reviewed-by: and Suggested-by:
 
-If this patch fixes a problem reported by somebody else, consider adding a
-Reported-by: tag to credit the reporter for their contribution.  Please
-note that this tag should not be added without the reporter's permission,
-especially if the problem was not reported in a public forum.  That said,
-if we diligently credit our bug reporters, they will, hopefully, be
-inspired to help us again in the future.
+The Reported-by tag is to give credit to people who find bugs and report them.
+Please note that if the bug was reported in private, then ask for permission
+first before using the Reported-by tag.
 
 A Tested-by: tag indicates that the patch has been successfully tested (in
 some environment) by the person named.  This tag informs maintainers that
--
Signature · 1 line
~Randy
maintainer
#7 lore raw

Re: [patch] Documentation/SubmittingPatches: Reported-by tags and permission

In reply to Dan Carpenter

Documentation/SubmittingPatches have been included in the discussion · line 437

Quoted 9 lines · On Fri, 14 Feb 2014 12:30:01 +0300 Dan Carpenter <[email protected]>…
Documentation/SubmittingPatches +3 -6
-If this patch fixes a problem reported by somebody else, consider adding a
-Reported-by: tag to credit the reporter for their contribution.  Please
-note that this tag should not be added without the reporter's permission,
-especially if the problem was not reported in a public forum.  That said,
-if we diligently credit our bug reporters, they will, hopefully, be
-inspired to help us again in the future.
+The Reported-by tag is to give credit to people who find bugs and report them.
+Please note that if the bug was reported in private, then ask for permission
+first before using the Reported-by tag.

As the guy who wrote the original text, I think this is an improvement...but can we get a version that retains the motivation for crediting bug reporters in the first place?

Thanks,

jon

#8 lore raw

Re: [patch] Documentation/SubmittingPatches: Reported-by tags and permission

Quoted 16 lines · Jonathan Corbet

Documentation/SubmittingPatches have been included in the discussion · line 437

Quoted 9 lines · On Fri, 14 Feb 2014 12:30:01 +0300 Dan Carpenter <[email protected]>…
Documentation/SubmittingPatches +3 -6
-If this patch fixes a problem reported by somebody else, consider adding a
-Reported-by: tag to credit the reporter for their contribution.  Please
-note that this tag should not be added without the reporter's permission,
-especially if the problem was not reported in a public forum.  That said,
-if we diligently credit our bug reporters, they will, hopefully, be
-inspired to help us again in the future.
+The Reported-by tag is to give credit to people who find bugs and report them.
+Please note that if the bug was reported in private, then ask for permission
+first before using the Reported-by tag.

As the guy who wrote the original text, I think this is an improvement...but can we get a version that retains the motivation for crediting bug reporters in the first place?

At the risk of upsetting the apple cart, I'd prefer we downplay anything that walks down the path of gamification (by focusing on credit).

As best anyone has ever explained it to me, the Acked-by, Reviewed-by, etc are there to impart information regarding a specific commit. In the event that a commit is fingered in a bisect, you have a much better list of names to Cc, instead of just the maintainer from MAINTAINERS and the author from the top of the offending file. The author has often moved on, and the maintainer may not have been around for the bugfix.

I know Greg has spoken out against gamification before, and I also understand the desire to encourage bug reporters. Perhaps I should just suggest the following:

"""
The Reported-by tag helps us maintain contact info for people with intimate knowledge of a commit or a bug fix. Please seek the reporter's permission before adding the tag to the commit. That said, if we diligently credit our bug reporters, they will, hopefully, be inspired to help us again in the future.
"""

It's most likely ok here since it's rather hard to manufacture a list of bugs in order to inflate ones count of Reported-by's. Unlike S-o-b, Ack's, etc.

thx,

Jason.

maintainer
#9 lore raw

Re: [patch] Documentation/SubmittingPatches: Reported-by tags and permission

Quoted 9 lines · On Tue, 28 Oct 2014 12:58:27 -0400 Jason Cooper <[email protected]> wrote:

At the risk of upsetting the apple cart, I'd prefer we downplay anything that walks down the path of gamification (by focusing on credit).

As best anyone has ever explained it to me, the Acked-by, Reviewed-by, etc are there to impart information regarding a specific commit. In the event that a commit is fingered in a bisect, you have a much better list of names to Cc, instead of just the maintainer from MAINTAINERS and the author from the top of the offending file. The author has often moved on, and the maintainer may not have been around for the bugfix.

As I understand it, having been in the room when these tags were developed and encouraged, was that credit was a big part of the initial motivation. We need more testers and bug reporters; this was a way to give them credit for the valuable work that they do. I still think that's important, for whatever that's worth.

Quoted 11 lines

I know Greg has spoken out against gamification before, and I also understand the desire to encourage bug reporters. Perhaps I should just suggest the following:

"""
The Reported-by tag helps us maintain contact info for people with intimate knowledge of a commit or a bug fix. Please seek the reporter's permission before adding the tag to the commit. That said, if we diligently credit our bug reporters, they will, hopefully, be inspired to help us again in the future.
"""

That addresses my concern, but loses the point of the initial patch:
publicly reporting a bug can be seen as implicit permission to credit the reporter.

Thanks,

jon

#10 lore raw

PATCH v2 1/1 Documentation/SubmittingPatches: Reported-by tags and permission

In reply to Jonathan Corbet

The reported-by text says you have to ask for permission, but that should only be if the bug was reported in private. These days the standard is to always give reported-by credit or it's considered a bit rude.

Documentation/SubmittingPatches +4 -6
index 482c749..1fa1caa 100644
@@ -483,12 +483,10 @@ have been included in the discussion
 
 14) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
 
-If this patch fixes a problem reported by somebody else, consider adding a
-Reported-by: tag to credit the reporter for their contribution.  Please
-note that this tag should not be added without the reporter's permission,
-especially if the problem was not reported in a public forum.  That said,
-if we diligently credit our bug reporters, they will, hopefully, be
-inspired to help us again in the future.
+The Reported-by tag gives credit to people who find bugs and report them and it
+hopefully inspires them to help us again in the future.  Please note that if
+the bug was reported in private, then ask for permission first before using the
+Reported-by tag.
 
 A Tested-by: tag indicates that the patch has been successfully tested (in
 some environment) by the person named.  This tag informs maintainers that
maintainer Applied
#11 lore raw

Re: [patch v2] Documentation/SubmittingPatches: Reported-by tags and permission

Quoted 6 lines · On Wed, 29 Oct 2014 13:01:36 +0300 Dan Carpenter <[email protected]>…

The reported-by text says you have to ask for permission, but that should only be if the bug was reported in private. These days the standard is to always give reported-by credit or it's considered a bit rude.

Applied, thanks.

jon

#12 lore raw

Re: [patch v2] Documentation/SubmittingPatches: Reported-by tags and permission

In reply to Dan Carpenter
Quoted 18 lines · Dan Carpenter

The reported-by text says you have to ask for permission, but that should only be if the bug was reported in private. These days the standard is to always give reported-by credit or it's considered a bit rude.

Documentation/SubmittingPatches +0 -3
index 482c749..1fa1caa 100644
@@ -483,12 +483,10 @@ have been included in the discussion
 
 14) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
 
-If this patch fixes a problem reported by somebody else, consider adding a
-Reported-by: tag to credit the reporter for their contribution.  Please
-note that this tag should not be added without the reporter's permission,

Documentation/SubmittingPatches have been included in the discussion · line 492

Quoted 10 lines
Documentation/SubmittingPatches +4 -3
-especially if the problem was not reported in a public forum.  That said,
-if we diligently credit our bug reporters, they will, hopefully, be
-inspired to help us again in the future.
+The Reported-by tag gives credit to people who find bugs and report them and it
+hopefully inspires them to help us again in the future.  Please note that if
+the bug was reported in private, then ask for permission first before using the
+Reported-by tag.
 
 A Tested-by: tag indicates that the patch has been successfully tested (in
 some environment) by the person named.  This tag informs maintainers that

Nitpick: no colon at end of tag name?

Rob

#13 lore raw
In reply to Paul Bolle
Quoted 4 lines · On Tuesday 11 February 2014 13:31:32 Paul Bolle wrote:

This patch also deserves a

line, but that apparently requires Martin's permission.

I would be happy. And I am sorry for not sending patches myself. As I expect to find some more issues in Kconfig files soon, I wanted to gather all of them before sending any patches. However, I did not expect this to take me so long. Therefore I am glad you took the initiative and just created some patches.

author
#14 lore raw
Quoted 7 lines · Martin Walch
Quoted 4 lines · On Tuesday 11 February 2014 13:31:32 Paul Bolle wrote:

This patch also deserves a

line, but that apparently requires Martin's permission.

I would be happy.

It seems I interpreted the requirements for Reported-By: tags rather strictly. We might change the documentation to discourage that interpretation. (Greg, is it too late to add this tag in your queue?)

Quoted 5 lines

And I am sorry for not sending patches myself. As I expect
to find some more issues in Kconfig files soon, I wanted to gather all of them before sending any patches. However, I did not expect this to take me so long. Therefore I am glad you took the initiative and just created some patches.

My experience is that one can easily get stuck when trying to fix all issues of a certain, broad category. Fixing all (say) all unused Kconfig symbols is a big job. Fixing all that got added in v3.14-rc1 is doable (depending on the amount of time one wants to spend).

Anyhow, I do hope you find time to send in patches yourself. Perhaps it would help if we'd coordinate the stuff a bit. Richard seems keen to help too.

Paul Bolle

author
#15 lore raw
Quoted 1 line · Paul Bolle

(Greg, is it too late to add this tag in your queue?)

Greg already did! It was "USB: ELAN: Remove useless "default M" lines" that lacks a Reported-by: tag.

Paul Bolle