docs: net: 80211: reduce docs build time

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 && 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 && 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/f0085721d85ebc3a77164b457ed948eee48b55df.1601890703.git.mchehab+huawei@kernel.orgSigned-off-by: Johannes Berg <johannes.berg@intel.com>

docs: net: 80211: reduce docs build time
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 && 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 && 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/f0085721d85ebc3a77164b457ed948eee48b55df.1601890703.git.mchehab+huawei@kernel.orgSigned-off-by: Johannes Berg <johannes.berg@intel.com>
efc7d01a · Mauro Carvalho Chehab · Johannes Berg · c1cd35c6 · efc7d01a · efc7d01a
Commit efc7d01a authored Oct 05, 2020 by Mauro Carvalho Chehab Committed by Johannes Berg Oct 08, 2020
3 changed files
--- a/Documentation/driver-api/80211/cfg80211.rst
+++ b/Documentation/driver-api/80211/cfg80211.rst
--- a/Documentation/driver-api/80211/mac80211-advanced.rst
+++ b/Documentation/driver-api/80211/mac80211-advanced.rst
@@ -15,25 +15,14 @@ appropriate trigger, which will then be triggered appropriately by
 mac80211.
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_get_tx_led_name
+   :functions:
+	ieee80211_get_tx_led_name
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_get_rx_led_name
-   :functions: ieee80211_get_rx_led_name
+	ieee80211_get_assoc_led_name
+	ieee80211_get_radio_led_name
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_tpt_blink
-   :functions: ieee80211_get_assoc_led_name
+	ieee80211_tpt_led_trigger_flags
+	ieee80211_create_tpt_led_trigger
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_get_radio_led_name
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_tpt_blink
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_tpt_led_trigger_flags
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_create_tpt_led_trigger
 Hardware crypto acceleration
 ============================
@@ -42,22 +31,13 @@ Hardware crypto acceleration
   :doc: Hardware crypto acceleration
 .. kernel-doc:: include/net/mac80211.h
-   :functions: set_key_cmd
+   :functions:
+	set_key_cmd
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_key_conf
-   :functions: ieee80211_key_conf
+	ieee80211_key_flags
+	ieee80211_get_tkip_p1k
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_get_tkip_p1k_iv
-   :functions: ieee80211_key_flags
+	ieee80211_get_tkip_p2k
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_get_tkip_p1k
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_get_tkip_p1k_iv
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_get_tkip_p2k
 Powersave support
 =================
@@ -99,28 +79,15 @@ support for powersaving clients
   :doc: AP support for powersaving clients
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_get_buffered_bc
+   :functions:
+	ieee80211_get_buffered_bc
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_beacon_get
-   :functions: ieee80211_beacon_get
+	ieee80211_sta_eosp
+	ieee80211_frame_release_type
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_sta_ps_transition
-   :functions: ieee80211_sta_eosp
+	ieee80211_sta_ps_transition_ni
+	ieee80211_sta_set_buffered
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_sta_block_awake
-   :functions: ieee80211_frame_release_type
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_sta_ps_transition
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_sta_ps_transition_ni
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_sta_set_buffered
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_sta_block_awake
 Supporting multiple virtual interfaces
 ======================================
@@ -134,10 +101,9 @@ addresses here, note which configurations are supported by mac80211, add
 notes about supporting hw crypto with it.
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_iterate_active_interfaces
+   :functions:
+	ieee80211_iterate_active_interfaces
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_iterate_active_interfaces_atomic
-   :functions: ieee80211_iterate_active_interfaces_atomic
 Station handling
 ================
@@ -145,16 +111,11 @@ Station handling
 TODO
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_sta
+   :functions:
+	ieee80211_sta
-.. kernel-doc:: include/net/mac80211.h
+	sta_notify_cmd
-   :functions: sta_notify_cmd
+	ieee80211_find_sta
+	ieee80211_find_sta_by_ifaddr
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_find_sta
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_find_sta_by_ifaddr
 Hardware scan offload
 =====================
@@ -193,10 +154,9 @@ Spatial Multiplexing Powersave (SMPS)
   :doc: Spatial multiplexing power save
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_request_smps
+   :functions:
+	ieee80211_request_smps
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_smps_mode
-   :functions: ieee80211_smps_mode
 TBD
@@ -209,22 +169,13 @@ Rate Control API
 TBD
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_start_tx_ba_session
+   :functions:
+	ieee80211_start_tx_ba_session
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_start_tx_ba_cb_irqsafe
-   :functions: ieee80211_start_tx_ba_cb_irqsafe
+	ieee80211_stop_tx_ba_session
+	ieee80211_stop_tx_ba_cb_irqsafe
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_rate_control_changed
-   :functions: ieee80211_stop_tx_ba_session
+	ieee80211_tx_rate_control
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_stop_tx_ba_cb_irqsafe
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rate_control_changed
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_tx_rate_control
 TBD
@@ -261,10 +212,9 @@ Programming information
 -----------------------
 .. kernel-doc:: net/mac80211/sta_info.h
-   :functions: sta_info
+   :functions:
+	sta_info
-.. kernel-doc:: net/mac80211/sta_info.h
+	ieee80211_sta_info_flags
-   :functions: ieee80211_sta_info_flags
 STA information lifetime rules
 ------------------------------
@@ -276,13 +226,10 @@ Aggregation Functions
 =====================
 .. kernel-doc:: net/mac80211/sta_info.h
-   :functions: sta_ampdu_mlme
+   :functions:
+	sta_ampdu_mlme
-.. kernel-doc:: net/mac80211/sta_info.h
+	tid_ampdu_tx
-   :functions: tid_ampdu_tx
+	tid_ampdu_rx
-.. kernel-doc:: net/mac80211/sta_info.h
-   :functions: tid_ampdu_rx
 Synchronisation Functions
 =========================

--- a/Documentation/driver-api/80211/mac80211.rst
+++ b/Documentation/driver-api/80211/mac80211.rst
@@ -30,31 +30,16 @@ Finally, a discussion of hardware capabilities should be done with
 references to other parts of the book.
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_hw
+   :functions:
+	ieee80211_hw
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_hw_flags
-   :functions: ieee80211_hw_flags
+	SET_IEEE80211_DEV
+	SET_IEEE80211_PERM_ADDR
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_ops
-   :functions: SET_IEEE80211_DEV
+	ieee80211_alloc_hw
+	ieee80211_register_hw
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_unregister_hw
-   :functions: SET_IEEE80211_PERM_ADDR
+	ieee80211_free_hw
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_ops
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_alloc_hw
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_register_hw
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_unregister_hw
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_free_hw
 PHY configuration
 =================
@@ -65,10 +50,9 @@ This chapter should describe PHY handling including start/stop callbacks
 and the various structures used.
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_conf
+   :functions:
+	ieee80211_conf
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_conf_flags
-   :functions: ieee80211_conf_flags
 Virtual interfaces
 ==================
@@ -123,79 +107,32 @@ functions/definitions
 ---------------------
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rx_status
+   :functions:
+	ieee80211_rx_status
-.. kernel-doc:: include/net/mac80211.h
+	mac80211_rx_encoding_flags
-   :functions: mac80211_rx_encoding_flags
+	mac80211_rx_flags
+	mac80211_tx_info_flags
-.. kernel-doc:: include/net/mac80211.h
+	mac80211_tx_control_flags
-   :functions: mac80211_rx_flags
+	mac80211_rate_control_flags
+	ieee80211_tx_rate
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_tx_info
-   :functions: mac80211_tx_info_flags
+	ieee80211_tx_info_clear_status
+	ieee80211_rx
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_rx_ni
-   :functions: mac80211_tx_control_flags
+	ieee80211_rx_irqsafe
+	ieee80211_tx_status
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_tx_status_ni
-   :functions: mac80211_rate_control_flags
+	ieee80211_tx_status_irqsafe
+	ieee80211_rts_get
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_rts_duration
-   :functions: ieee80211_tx_rate
+	ieee80211_ctstoself_get
+	ieee80211_ctstoself_duration
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_generic_frame_duration
-   :functions: ieee80211_tx_info
+	ieee80211_wake_queue
+	ieee80211_stop_queue
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_wake_queues
-   :functions: ieee80211_tx_info_clear_status
+	ieee80211_stop_queues
+	ieee80211_queue_stopped
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rx
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rx_ni
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rx_irqsafe
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_tx_status
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_tx_status_ni
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_tx_status_irqsafe
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rts_get
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_rts_duration
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_ctstoself_get
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_ctstoself_duration
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_generic_frame_duration
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_wake_queue
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_stop_queue
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_wake_queues
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_stop_queues
-.. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_queue_stopped
 Frame filtering
 ===============
@@ -213,7 +150,6 @@ The mac80211 workqueue
   :doc: mac80211 workqueue
 .. kernel-doc:: include/net/mac80211.h
-   :functions: ieee80211_queue_work
+   :functions:
+	ieee80211_queue_work
-.. kernel-doc:: include/net/mac80211.h
+	ieee80211_queue_delayed_work
-   :functions: ieee80211_queue_delayed_work