Pull documentation updates from Mauro Carvalho Chehab: "A series of patches addressing warnings produced by make htmldocs. This includes: - kernel-doc markup fixes - ReST fixes - Updates at the build system in order to support newer versions of the docs build toolchain (Sphinx) After this series, the number of html build warnings should reduce significantly, and building with Sphinx 3.1 or later should now be supported (although it is still recommended to use Sphinx 2.4.4). As agreed with Jon, I should be sending you a late pull request by the end of the merge window addressing remaining issues with docs build, as there are a number of warning fixes that depends on pull requests that should be happening along the merge window. The end goal is to have a clean htmldocs build on Kernel 5.10. PS. It should be noticed that Sphinx 3.0 is not currently supported, as it lacks support for C domain namespaces. Such feature, needed in order to document uAPI system calls with Sphinx 3.x, was added only on Sphinx 3.1" * tag 'docs/v5.10-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media: (75 commits) PM / devfreq: remove a duplicated kernel-doc markup mm/doc: fix a literal block markup workqueue: fix a kernel-doc warning docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup Input: sparse-keymap: add a description for @sw rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu nl80211: docs: add a description for s1g_cap parameter usb: docs: document altmode register/unregister functions kunit: test.h: fix a bad kernel-doc markup drivers: core: fix kernel-doc markup for dev_err_probe() docs: bio: fix a kerneldoc markup kunit: test.h: solve kernel-doc warnings block: bio: fix a warning at the kernel-doc markups docs: powerpc: syscall64-abi.rst: fix a malformed table drivers: net: hamradio: fix document location net: appletalk: Kconfig: Fix docs location dt-bindings: fix references to files converted to yaml memblock: get rid of a :c:type leftover math64.h: kernel-docs: Convert some markups into normal comments media: uAPI: buffer.rst: remove a left-over documentation ...
Showing the changes to kernel (2 of 309 files). Show all
Unified · Split
| @@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work { · 3021 unmodified lines | ||
| 3022 | 3022 | * @monitor_todo: Tracks whether a @monitor_work delayed work is pending |
| 3023 | 3023 | * @initialized: The @rcu_work fields have been initialized |
| 3024 | 3024 | * @count: Number of objects for which GP not started |
| 3025 | + * @bkvcache: | |
| 3026 | + * A simple cache list that contains objects for reuse purpose. | |
| 3027 | + * In order to save some per-cpu space the list is singular. | |
| 3028 | + * Even though it is lockless an access has to be protected by the | |
| 3029 | + * per-cpu lock. | |
| 3030 | + * @nr_bkv_objs: number of allocated objects at @bkvcache. | |
| 3025 | 3031 | * |
| 3026 | 3032 | * This is a per-CPU structure. The reason that it is not included in |
| 3027 | 3033 | * the rcu_data structure is to permit this code to be extracted from |
| @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu { · 9 unmodified lines | ||
| 3037 | 3043 | bool monitor_todo; |
| 3038 | 3044 | bool initialized; |
| 3039 | 3045 | int count; |
| 3040 | − | |
| 3041 | − /* | |
| 3042 | − * A simple cache list that contains objects for | |
| 3043 | − * reuse purpose. In order to save some per-cpu | |
| 3044 | − * space the list is singular. Even though it is | |
| 3045 | − * lockless an access has to be protected by the | |
| 3046 | − * per-cpu lock. | |
| 3047 | − */ | |
| 3048 | 3046 | struct llist_head bkvcache; |
| 3049 | 3047 | int nr_bkv_objs; |
| 3050 | 3048 | }; |
| @@ -1212,11 +1212,14 @@ out_put: · 1211 unmodified lines | ||
| 1212 | 1212 | * stable state - idle, on timer or on worklist. |
| 1213 | 1213 | * |
| 1214 | 1214 | * Return: |
| 1215 | + * | |
| 1216 | + * ======== ================================================================ | |
| 1215 | 1217 | * 1 if @work was pending and we successfully stole PENDING |
| 1216 | 1218 | * 0 if @work was idle and we claimed PENDING |
| 1217 | 1219 | * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry |
| 1218 | 1220 | * -ENOENT if someone else is canceling @work, this state may persist |
| 1219 | 1221 | * for arbitrarily long |
| 1222 | + * ======== ================================================================ | |
| 1220 | 1223 | * |
| 1221 | 1224 | * Note: |
| 1222 | 1225 | * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting |