diff mbox

bonding: document undocumented active_slave sysfs entry.

Message ID 1324901955-5816-1-git-send-email-nicolas.2p.debian@free.fr
State Changes Requested, archived
Delegated to: David Miller
Headers show

Commit Message

Nicolas de Pesloüan Dec. 26, 2011, 12:19 p.m. UTC
Signed-off-by: Nicolas de Pesloüan <nicolas.2p.debian@free.fr>
cc: Jay Vosburgh <fubar@us.ibm.com>
cc: Andy Gospodarek <andy@greyhouse.net>

---
 Documentation/networking/bonding.txt |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

Comments

David Miller Dec. 26, 2011, 8:20 p.m. UTC | #1
From: Nicolas de Pesloüan <nicolas.2p.debian@free.fr>
Date: Mon, 26 Dec 2011 13:19:15 +0100

> Signed-off-by: Nicolas de Pesloüan <nicolas.2p.debian@free.fr>
> cc: Jay Vosburgh <fubar@us.ibm.com>
> cc: Andy Gospodarek <andy@greyhouse.net>

Jay/Andy, please review.
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jay Vosburgh Dec. 26, 2011, 9:10 p.m. UTC | #2
Nicolas de Pesloüan 	<nicolas.2p.debian@free.fr> wrote:

>Signed-off-by: Nicolas de Pesloüan <nicolas.2p.debian@free.fr>
>cc: Jay Vosburgh <fubar@us.ibm.com>
>cc: Andy Gospodarek <andy@greyhouse.net>
>
>---
> Documentation/networking/bonding.txt |   14 ++++++++++++++
> 1 files changed, 14 insertions(+), 0 deletions(-)
>
>diff --git a/Documentation/networking/bonding.txt b/Documentation/networking/bonding.txt
>index 91df678..83b44c2 100644
>--- a/Documentation/networking/bonding.txt
>+++ b/Documentation/networking/bonding.txt
>@@ -196,6 +196,20 @@ or, for backwards compatibility, the option value.  E.g.,
>
> 	The parameters are as follows:
>
>+active_slave
>+
>+	Specifies the active slave for modes that support it (active-backup,
>+	balance-alb and balance-tlb). The possible values are one of the
>+	currently enslaved slaves. The selected slave must be up and the
>+	underlying link must be up too.

	I would phrase this a bit differently, also including the empty
string as a possible value:

	Specifies the new active slave for modes that support it
	(active-backup, balance-alb and balance-tlb).  Possible values
	are the name of any currently enslaved interface, or an empty
	string.  If a name is given, the slave must be up in order to be
	selected as the new active slave.  If an empty string is
	specified, the current active slave is cleared, and a new active
	slave is selected automatically.

>+	Note that this is only available through the sysfs interface. No module
>+	parameter by that name exists.
	
	"by this name" instead of "that".

>+	The default value is empty (no active slave). It will automatically be
>+	set every time an active slave is selected by normal bonding operation.
>+	The current active slave can be read from this sysfs entry.

	I'd write this as:

	The normal value of this option is the name of the currently
	active slave, or the empty string if there is no active slave or
	the current mode does not use an active slave.

	With the above changes (or something pretty much equivalent) I'm
good with this, and you can add a signed-off for me.

	-J

---
	-Jay Vosburgh, IBM Linux Technology Center, fubar@us.ibm.com

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Nicolas de Pesloüan Dec. 26, 2011, 10:51 p.m. UTC | #3
Le 26/12/2011 22:10, Jay Vosburgh a écrit :
> Nicolas de Pesloüan 	<nicolas.2p.debian@free.fr>  wrote:
>
>> Signed-off-by: Nicolas de Pesloüan<nicolas.2p.debian@free.fr>
>> cc: Jay Vosburgh<fubar@us.ibm.com>
>> cc: Andy Gospodarek<andy@greyhouse.net>
>>
>> ---
>> Documentation/networking/bonding.txt |   14 ++++++++++++++
>> 1 files changed, 14 insertions(+), 0 deletions(-)
>>
>> diff --git a/Documentation/networking/bonding.txt b/Documentation/networking/bonding.txt
>> index 91df678..83b44c2 100644
>> --- a/Documentation/networking/bonding.txt
>> +++ b/Documentation/networking/bonding.txt
>> @@ -196,6 +196,20 @@ or, for backwards compatibility, the option value.  E.g.,
>>
>> 	The parameters are as follows:
>>
>> +active_slave
>> +
>> +	Specifies the active slave for modes that support it (active-backup,
>> +	balance-alb and balance-tlb). The possible values are one of the
>> +	currently enslaved slaves. The selected slave must be up and the
>> +	underlying link must be up too.
>
> 	I would phrase this a bit differently, also including the empty
> string as a possible value:
>
> 	Specifies the new active slave for modes that support it
> 	(active-backup, balance-alb and balance-tlb).  Possible values
> 	are the name of any currently enslaved interface, or an empty
> 	string.  If a name is given, the slave must be up in order to be
> 	selected as the new active slave.  If an empty string is
> 	specified, the current active slave is cleared, and a new active
> 	slave is selected automatically.
>
>> +	Note that this is only available through the sysfs interface. No module
>> +	parameter by that name exists.
> 	
> 	"by this name" instead of "that".
>
>> +	The default value is empty (no active slave). It will automatically be
>> +	set every time an active slave is selected by normal bonding operation.
>> +	The current active slave can be read from this sysfs entry.
>
> 	I'd write this as:
>
> 	The normal value of this option is the name of the currently
> 	active slave, or the empty string if there is no active slave or
> 	the current mode does not use an active slave.
>
> 	With the above changes (or something pretty much equivalent) I'm
> good with this, and you can add a signed-off for me.


Thanks for the review. I will send V2 later.

	Nicolas.
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/networking/bonding.txt b/Documentation/networking/bonding.txt
index 91df678..83b44c2 100644
--- a/Documentation/networking/bonding.txt
+++ b/Documentation/networking/bonding.txt
@@ -196,6 +196,20 @@  or, for backwards compatibility, the option value.  E.g.,
 
 	The parameters are as follows:
 
+active_slave
+
+	Specifies the active slave for modes that support it (active-backup,
+	balance-alb and balance-tlb). The possible values are one of the
+	currently enslaved slaves. The selected slave must be up and the
+	underlying link must be up too.
+	
+	Note that this is only available through the sysfs interface. No module
+	parameter by that name exists.
+
+	The default value is empty (no active slave). It will automatically be
+	set every time an active slave is selected by normal bonding operation.
+	The current active slave can be read from this sysfs entry.
+
 ad_select
 
 	Specifies the 802.3ad aggregation selection logic to use.  The