[PATCH 1/2] cfg80211: docbook: fix small formatting error

[PATCH 1/2] cfg80211: docbook: fix small formatting error

[Luciano Coelho]

From: Luciano Coelho <luciano.coelho@intel.com>

docbook (or one of its friends) gets confused with semi-colons in the
argument descriptions, causing it to think that the semi-colon is
marking a new section in the description of addr_mask in wiphy struct.

Prevent this by using hyphens instead of semi-colons in the mask
example.

Signed-off-by: Luciano Coelho <luciano.coelho@intel.com>
---
 include/net/cfg80211.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index c89a5b5..2c53749 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -2791,7 +2791,7 @@ struct wiphy_vendor_command {
  * @perm_addr: permanent MAC address of this device
  * @addr_mask: If the device supports multiple MAC addresses by masking,
  *	set this to a mask with variable bits set to 1, e.g. if the last
- *	four bits are variable then set it to 00:...:00:0f. The actual
+ *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
  *	variable bits shall be determined by the interfaces added, with
  *	interfaces not matching the mask being rejected to be brought up.
  * @n_addresses: number of addresses in @addresses.
-- 
1.8.5.3

[PATCH 2/2] cfg80211: docbook: add interface combinations documentation

[Luciano Coelho]

From: Luciano Coelho <luciano.coelho@intel.com>

Add the ieee80211_iface_limit and the ieee80211_iface_combination
structures to docbook.  Reformat the examples of combinations
slightly, so it looks a bit better on docbook.

Signed-off-by: Luciano Coelho <luciano.coelho@intel.com>
---
 Documentation/DocBook/80211.tmpl |  2 ++
 include/net/cfg80211.h           | 12 ++++++++----
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl
index 46ad6fa..044b764 100644
--- a/Documentation/DocBook/80211.tmpl
+++ b/Documentation/DocBook/80211.tmpl
@@ -98,6 +98,8 @@
 !Finclude/net/cfg80211.h priv_to_wiphy
 !Finclude/net/cfg80211.h set_wiphy_dev
 !Finclude/net/cfg80211.h wdev_priv
+!Finclude/net/cfg80211.h ieee80211_iface_limit
+!Finclude/net/cfg80211.h ieee80211_iface_combination
       </chapter>
       <chapter>
       <title>Actions and configuration</title>
diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 2c53749..f7a8d69 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -2611,9 +2611,12 @@ struct ieee80211_iface_limit {
  *	only in special cases.
  * @radar_detect_widths: bitmap of channel widths supported for radar detection
  *
- * These examples can be expressed as follows:
+ * With this structure the driver can describe which interface
+ * combinations it supports concurrently.
  *
- * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
+ * Examples:
+ *
+ * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
  *
  *  struct ieee80211_iface_limit limits1[] = {
  *	{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
@@ -2627,7 +2630,7 @@ struct ieee80211_iface_limit {
  *  };
  *
  *
- * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
+ * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
  *
  *  struct ieee80211_iface_limit limits2[] = {
  *	{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
@@ -2641,7 +2644,8 @@ struct ieee80211_iface_limit {
  *  };
  *
  *
- * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
+ * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
+ *
  * This allows for an infrastructure connection and three P2P connections.
  *
  *  struct ieee80211_iface_limit limits3[] = {
-- 
1.8.5.3

Re: [PATCH 1/2] cfg80211: docbook: fix small formatting error

[Johannes Berg]

On Thu, 2014-02-20 at 16:45 +0200, Luciano Coelho wrote:
> From: Luciano Coelho <luciano.coelho@intel.com>
> 
> docbook (or one of its friends) gets confused with semi-colons in the
> argument descriptions, causing it to think that the semi-colon is
> marking a new section in the description of addr_mask in wiphy struct.
> 
> Prevent this by using hyphens instead of semi-colons in the mask
> example.

Applied, thanks.

johannes

Re: [PATCH 2/2] cfg80211: docbook: add interface combinations documentation

[Johannes Berg]

On Thu, 2014-02-20 at 16:45 +0200, Luciano Coelho wrote:
> From: Luciano Coelho <luciano.coelho@intel.com>
> 
> Add the ieee80211_iface_limit and the ieee80211_iface_combination
> structures to docbook.  Reformat the examples of combinations
> slightly, so it looks a bit better on docbook.

Applied, thanks.

johannes

Re: [PATCH 1/2] cfg80211: docbook: fix small formatting error

[Jones Desougi]

On 02/21/2014 09:23 AM, Johannes Berg wrote:
> On Thu, 2014-02-20 at 16:45 +0200, Luciano Coelho wrote:
>> From: Luciano Coelho <luciano.coelho@intel.com>
>>
>> docbook (or one of its friends) gets confused with semi-colons in the
>> argument descriptions, causing it to think that the semi-colon is
>> marking a new section in the description of addr_mask in wiphy struct.
>>
>> Prevent this by using hyphens instead of semi-colons in the mask
>> example.
> 
> Applied, thanks.

Well, the changelog says that semi-colons are a problem while the patch
actually replaces colons. Fishy. :)

   /Jones

Re: [PATCH 1/2] cfg80211: docbook: fix small formatting error

[Luca Coelho]

On Fri, 2014-02-21 at 15:51 +0100, Jones Desougi wrote:
> On 02/21/2014 09:23 AM, Johannes Berg wrote:
> > On Thu, 2014-02-20 at 16:45 +0200, Luciano Coelho wrote:
> >> From: Luciano Coelho <luciano.coelho@intel.com>
> >>
> >> docbook (or one of its friends) gets confused with semi-colons in the
> >> argument descriptions, causing it to think that the semi-colon is
> >> marking a new section in the description of addr_mask in wiphy struct.
> >>
> >> Prevent this by using hyphens instead of semi-colons in the mask
> >> example.
> > 
> > Applied, thanks.
> 
> Well, the changelog says that semi-colons are a problem while the patch
> actually replaces colons. Fishy. :)

Heh! Yeah, my mistake.  I probably already had a beer in my hand when I
wrote the commit message since it was a Monday evening.  Oh wait..! ;)

--
Cheers,
Luca.