<feed xmlns='http://www.w3.org/2005/Atom'>
<title>linux-toradex.git/Documentation/driver-api/80211/mac80211.rst, branch v6.4</title>
<subtitle>Linux kernel for Apalis and Colibri modules</subtitle>
<link rel='alternate' type='text/html' href='https://git.toradex.cn/cgit/linux-toradex.git/'/>
<entry>
<title>docs: net: 80211: reduce docs build time</title>
<updated>2020-10-08T08:41:49+00:00</updated>
<author>
<name>Mauro Carvalho Chehab</name>
<email>mchehab+huawei@kernel.org</email>
</author>
<published>2020-10-05T09:38:37+00:00</published>
<link rel='alternate' type='text/html' href='https://git.toradex.cn/cgit/linux-toradex.git/commit/?id=efc7d01a9ecdc59946fad1743d96a0db9925064c'/>
<id>efc7d01a9ecdc59946fad1743d96a0db9925064c</id>
<content type='text'>
the files under /80211 calls kernel-doc script 207 times, one for each
single function and doc chapter. Due to that, it takes a lot of time
handling it:

	$ touch Documentation/driver-api/80211/*rst &amp;&amp; time make SPHINXDIRS=driver-api/80211 htmldocs
...
	real	0m22,928s
	user	0m21,644s
	sys	0m1,334s

Reduce the build time by doing only one kernel-doc call
per functions that belong to the same group. With that, there's now
50 calls to kernel-doc, which makes the build time for those docs
62% faster:

	$ touch Documentation/driver-api/80211/*rst &amp;&amp; time make SPHINXDIRS=driver-api/80211 htmldocs
...
	real	0m8,666s
	user	0m8,084s
	sys	0m0,642s

As a side effect, it should now be easier to add newer
functions, as there's no need to repeat the kernel-doc
pattern.

Measurements made on a NUC8i7HNK machine with lots of ram
and a fast SSD disk with Sphinx 3.2.1.

Signed-off-by: Mauro Carvalho Chehab &lt;mchehab+huawei@kernel.org&gt;
Link: https://lore.kernel.org/r/f0085721d85ebc3a77164b457ed948eee48b55df.1601890703.git.mchehab+huawei@kernel.org
Signed-off-by: Johannes Berg &lt;johannes.berg@intel.com&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
the files under /80211 calls kernel-doc script 207 times, one for each
single function and doc chapter. Due to that, it takes a lot of time
handling it:

	$ touch Documentation/driver-api/80211/*rst &amp;&amp; time make SPHINXDIRS=driver-api/80211 htmldocs
...
	real	0m22,928s
	user	0m21,644s
	sys	0m1,334s

Reduce the build time by doing only one kernel-doc call
per functions that belong to the same group. With that, there's now
50 calls to kernel-doc, which makes the build time for those docs
62% faster:

	$ touch Documentation/driver-api/80211/*rst &amp;&amp; time make SPHINXDIRS=driver-api/80211 htmldocs
...
	real	0m8,666s
	user	0m8,084s
	sys	0m0,642s

As a side effect, it should now be easier to add newer
functions, as there's no need to repeat the kernel-doc
pattern.

Measurements made on a NUC8i7HNK machine with lots of ram
and a fast SSD disk with Sphinx 3.2.1.

Signed-off-by: Mauro Carvalho Chehab &lt;mchehab+huawei@kernel.org&gt;
Link: https://lore.kernel.org/r/f0085721d85ebc3a77164b457ed948eee48b55df.1601890703.git.mchehab+huawei@kernel.org
Signed-off-by: Johannes Berg &lt;johannes.berg@intel.com&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>mac80211: fix missing/malformed documentation</title>
<updated>2019-02-01T11:11:13+00:00</updated>
<author>
<name>Johannes Berg</name>
<email>johannes.berg@intel.com</email>
</author>
<published>2019-02-01T10:53:32+00:00</published>
<link rel='alternate' type='text/html' href='https://git.toradex.cn/cgit/linux-toradex.git/commit/?id=7d4194633b29342d93501b53accebf638da134ad'/>
<id>7d4194633b29342d93501b53accebf638da134ad</id>
<content type='text'>
Fix the missing and malformed documentation that kernel-doc and
sphinx warn about. While at it, also add some things to the docs
to fix missing links.

Sadly, the only way I could find to fix this was to add some
trailing whitespace.

Signed-off-by: Johannes Berg &lt;johannes.berg@intel.com&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Fix the missing and malformed documentation that kernel-doc and
sphinx warn about. While at it, also add some things to the docs
to fix missing links.

Sadly, the only way I could find to fix this was to add some
trailing whitespace.

Signed-off-by: Johannes Berg &lt;johannes.berg@intel.com&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>docs: Move the 802.11 guide into the driver-api manual</title>
<updated>2016-11-29T21:41:49+00:00</updated>
<author>
<name>Jonathan Corbet</name>
<email>corbet@lwn.net</email>
</author>
<published>2016-11-18T23:04:48+00:00</published>
<link rel='alternate' type='text/html' href='https://git.toradex.cn/cgit/linux-toradex.git/commit/?id=0bb33e25e5c91f69304f3799609a52354dca1af4'/>
<id>0bb33e25e5c91f69304f3799609a52354dca1af4</id>
<content type='text'>
Put this documentation with the other driver docs and try to keep the top
level reasonably clean.

Cc: Johannes Berg &lt;johannes.berg@intel.com&gt;
Signed-off-by: Jonathan Corbet &lt;corbet@lwn.net&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Put this documentation with the other driver docs and try to keep the top
level reasonably clean.

Cc: Johannes Berg &lt;johannes.berg@intel.com&gt;
Signed-off-by: Jonathan Corbet &lt;corbet@lwn.net&gt;
</pre>
</div>
</content>
</entry>
</feed>
