diff mbox

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

Message ID 1392907534-14470-1-git-send-email-luca@coelho.fi (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

Luca Coelho Feb. 20, 2014, 2:45 p.m. UTC
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(-)

Comments

Johannes Berg Feb. 21, 2014, 8:23 a.m. UTC | #1
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

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jones Desougi Feb. 21, 2014, 2:51 p.m. UTC | #2
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

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Luca Coelho Feb. 21, 2014, 2:59 p.m. UTC | #3
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.

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" 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/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.