[PATCH] include: net: Add parameter desc to fix waring when generating docs

[PATCH] include: net: Add parameter desc to fix waring when generating docs

[Sam Bristow]

'make htmldocs' was generating a warning about a missing parameter description
for gfp.

Earlier patch was missing my signed-off-by line...
Signed-off-by: Sam Bristow <sam.bristow@gmail.com>
---
 include/net/cfg80211.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 26b5b69..159e070 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -4153,6 +4153,7 @@ void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
  *
  * @wdev: the wireless device for which critical protocol is stopped.
+ * @gfp: allocation flags
  *
  * This function can be called by the driver to indicate it has reverted
  * operation back to normal. One reason could be that the duration given
-- 
1.8.3.1

Re: [PATCH] include: net: Add parameter desc to fix waring when generating docs

[Luciano Coelho]

On Fri, 2013-07-05 at 09:59 +1200, Sam Bristow wrote:
> 'make htmldocs' was generating a warning about a missing parameter description
> for gfp.
> 
> Earlier patch was missing my signed-off-by line...
> Signed-off-by: Sam Bristow <sam.bristow-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> ---

You have a typo in the patch subject (it was not there in your previous
version ;).

Also, you shouldn't add explanations about the different versions of the
patch in the commit message (in you case the "Earlier patch was missing
my signed-off-by line..." text).  If you want to add this kind of
comments, add it after the "---" under the Signed-of tags.

One more thing, it's a good idea to use [PATCH v2] when you're sending a
second version of the same patch.  That can be easily done with git
format-patch (and also with git send-email) by using an argument like
this: --subject-prefix="PATCH v2"

--
Luca.

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html