Re: [PATCH 1/2] Documentation/sphinx: kerneldoc: add "unused-functions"

2017-04-04 Thread Jani Nikula
On Mon, 03 Apr 2017, Johannes Berg wrote: > On Fri, 2017-03-31 at 15:54 +0300, Jani Nikula wrote: >> >> I'm sure the parameter name could be improved to capture what you >> mean better; alas I don't have a suggestion. > > Yes, that's a fair point - p

Re: [PATCH 1/2] Documentation/sphinx: kerneldoc: add "unused-functions"

2017-03-31 Thread Jani Nikula
fns_this_file.append(f) > +elif 'unused-functions' in self.options: > +for f in _used_fns_this_file: > +cmd += ['-nofunction', f] > elif 'functions' in self.options: > for f in str(self.options.get('functions')).split(): > cmd += ['-function', f] > +_used_fns_this_file.append(f) > > for pattern in export_file_patterns: > for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern): -- Jani Nikula, Intel Open Source Technology Center

Re: [PATCH 2/2] mac80211: use inline kernel-doc for struct ieee80211_hw

2016-10-26 Thread Jani Nikula
On Wed, 26 Oct 2016, Johannes Berg wrote: > On Fri, 2016-10-21 at 15:57 +0300, Jani Nikula wrote: >> It's easier to manage the kernel-doc for the fields when they >> documentation is next to the field. > > Ok, actually, this doesn't apply. Perhaps I'l

Re: [PATCH 2/2] mac80211: use inline kernel-doc for struct ieee80211_hw

2016-10-21 Thread Jani Nikula
On Fri, 21 Oct 2016, Johannes Berg wrote: > On Fri, 2016-10-21 at 15:57 +0300, Jani Nikula wrote: >> It's easier to manage the kernel-doc for the fields when they >> documentation is next to the field. > > Hah, I wasn't even aware this was possible. Thanks! It is

Re: [PATCH 1/2] mac80211: fix some sphinx warnings

2016-10-21 Thread Jani Nikula
On Fri, 21 Oct 2016, Johannes Berg wrote: > On Fri, 2016-10-21 at 15:57 +0300, Jani Nikula wrote: >> Signed-off-by: Jani Nikula >> --- >>  include/net/mac80211.h | 21 + >>  1 file changed, 13 insertions(+), 8 deletions(-) >> >> diff -

[PATCH 2/2] mac80211: use inline kernel-doc for struct ieee80211_hw

2016-10-21 Thread Jani Nikula
It's easier to manage the kernel-doc for the fields when they documentation is next to the field. Signed-off-by: Jani Nikula --- The same treatment is sorely needed for struct ieee80211_ops also, but I don't have the time... this would get rid of the rest of the warnings in

Re: sequence diagrams in rst documentation

2016-10-21 Thread Jani Nikula
alls out to ... > > > Perhaps we can have a compromise and embed the raw text when the > tooling isn't all installed, so you can still build useful > documentation, but to get all the "prettiness" you might have to > install more dependencies? I had the same con

[PATCH 1/2] mac80211: fix some sphinx warnings

2016-10-21 Thread Jani Nikula
Signed-off-by: Jani Nikula --- include/net/mac80211.h | 21 + 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/include/net/mac80211.h b/include/net/mac80211.h index a810dfcb83c2..e2dba93e374f 100644 --- a/include/net/mac80211.h +++ b/include/net/mac80211.h

Re: sequence diagrams in rst documentation

2016-10-19 Thread Jani Nikula
On Wed, 19 Oct 2016, Markus Heiser wrote: > Am 18.10.2016 um 16:52 schrieb Jani Nikula : > >>> *Only* adding the PNG would be awful, I'd have to keep track of the >>> corresponding source elsewhere, and perhaps couldn't even GPL it >>> because

Re: sequence diagrams in rst documentation

2016-10-18 Thread Jani Nikula
ed. And there are other problems with attaching binaries (although I'd say we should fix them too) [1]. BR, Jani. [1] http://lkml.kernel.org/r/02a78907-933d-3f61-572e-28154b16b...@redhat.com -- Jani Nikula, Intel Open Source Technology Center