[PATCH] rfkill: parameters documentation

[PATCH] rfkill: parameters documentation

[Andrew Clausen]

Hi all,

This patch documents two rfkill module parameters, namely
rfkill.default_state and rfkill.master_switch_mode.

I constructed the patch from Ubuntu packaged source, but I'm happy to
adapt it to any git tree.

Kind regards,
Andrew

Signed-off-by: Andrew Clausen <andrew.p.clausen@gmail.com>
---

diff --git a/Documentation/kernel-parameters.txt
b/Documentation/kernel-parameters.txt
index 011855b..824ee3b 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -2999,6 +2999,20 @@ bytes respectively. Such letter suffixes can
also be entirely omitted.

     retain_initrd    [RAM] Keep initrd memory after extraction

+    rfkill.default_state=
+        0        "airplane mode".  All wifi, bluetooth, wimax,
+                gps, fm, etc. communication is blocked by
+                default.
+        1        Unblocked.
+
+    rfkill.master_switch_mode=
+        0        The "airplane mode" button does nothing.
+        1        The "airplane mode" button toggles between
+                everything blocked and the previous
+                configuration.
+        2        The "airplane mode" button toggles between
+                everything blocked and everything unblocked.
+
     rhash_entries=    [KNL,NET]
             Set number of hash buckets for route cache

diff --git a/Documentation/rfkill.txt b/Documentation/rfkill.txt
index 427e897..2ee6ef9 100644
--- a/Documentation/rfkill.txt
+++ b/Documentation/rfkill.txt
@@ -25,6 +25,9 @@ whether they can be changed or not:
  - soft block: writable radio block (need not be readable) that is set by
                the system software.

+The rfkill subsystem has two parameters, rfkill.default_state and
+rfkill.master_switch_mode, which are documented in kernel-parameters.txt.
+

 2. Implementation details

Re: [PATCH] rfkill: parameters documentation

[Johannes Berg]

On Fri, 2015-01-02 at 19:01 +0000, Andrew Clausen wrote:
> Hi all,
> 
> This patch documents two rfkill module parameters, namely
> rfkill.default_state and rfkill.master_switch_mode.
> 
> I constructed the patch from Ubuntu packaged source, but I'm happy to
> adapt it to any git tree.
> 
> Kind regards,
> Andrew
> 
> Signed-off-by: Andrew Clausen <andrew.p.clausen@gmail.com>

Looks fine to me (though the commit message shouldn't contain the email
"boilerplate" of "hi all" etc - should just be

rfkill: document module parameters

Document the two rfkill module parameters "default_state" and
"master_switch_mode".

Signed-off-by: ...


However I'm not sure I should apply this through my tree?

johannes

> ---
> 
> diff --git a/Documentation/kernel-parameters.txt
> b/Documentation/kernel-parameters.txt
> index 011855b..824ee3b 100644
> --- a/Documentation/kernel-parameters.txt
> +++ b/Documentation/kernel-parameters.txt
> @@ -2999,6 +2999,20 @@ bytes respectively. Such letter suffixes can
> also be entirely omitted.
> 
>      retain_initrd    [RAM] Keep initrd memory after extraction
> 
> +    rfkill.default_state=
> +        0        "airplane mode".  All wifi, bluetooth, wimax,
> +                gps, fm, etc. communication is blocked by
> +                default.
> +        1        Unblocked.
> +
> +    rfkill.master_switch_mode=
> +        0        The "airplane mode" button does nothing.
> +        1        The "airplane mode" button toggles between
> +                everything blocked and the previous
> +                configuration.
> +        2        The "airplane mode" button toggles between
> +                everything blocked and everything unblocked.
> +
>      rhash_entries=    [KNL,NET]
>              Set number of hash buckets for route cache
> 
> diff --git a/Documentation/rfkill.txt b/Documentation/rfkill.txt
> index 427e897..2ee6ef9 100644
> --- a/Documentation/rfkill.txt
> +++ b/Documentation/rfkill.txt
> @@ -25,6 +25,9 @@ whether they can be changed or not:
>   - soft block: writable radio block (need not be readable) that is set by
>                 the system software.
> 
> +The rfkill subsystem has two parameters, rfkill.default_state and
> +rfkill.master_switch_mode, which are documented in kernel-parameters.txt.
> +
> 
>  2. Implementation details
> 

Re: [PATCH] rfkill: parameters documentation

[Andrew Clausen]

Hi Johannes,

On 5 January 2015 at 09:24, Johannes Berg <johannes@sipsolutions.net> wrote:
> Looks fine to me (though the commit message shouldn't contain the email
> "boilerplate" of "hi all" etc - should just be

Ah, sorry for the extra noise.

> However I'm not sure I should apply this through my tree?

I think you're right -- it makes sense to put it in your tree, and
merge it down the track.  (I don't think I've submitted a kernel patch
since pre-git days, so sorry for the confusion.)

Cheers,
Andrew

Re: [PATCH] rfkill: parameters documentation

[Johannes Berg]

On Mon, 2015-01-05 at 10:03 +0000, Andrew Clausen wrote:
> Hi Johannes,
> 
> On 5 January 2015 at 09:24, Johannes Berg <johannes@sipsolutions.net> wrote:
> > Looks fine to me (though the commit message shouldn't contain the email
> > "boilerplate" of "hi all" etc - should just be
> 
> Ah, sorry for the extra noise.
> 
> > However I'm not sure I should apply this through my tree?
> 
> I think you're right -- it makes sense to put it in your tree, and
> merge it down the track.  (I don't think I've submitted a kernel patch
> since pre-git days, so sorry for the confusion.)

I'll take it.

However, please resend with an adjust commit message, and please diff it
against my mac80211-next tree (it doesn't apply as is)

johannes

Re: [PATCH] rfkill: parameters documentation

[Johannes Berg]

On Fri, 2015-01-02 at 19:01 +0000, Andrew Clausen wrote:
> Hi all,
> 
> This patch documents two rfkill module parameters, namely
> rfkill.default_state and rfkill.master_switch_mode.

Andrew sent me a white-space fixed version in private email, which I've
applied.

johannes