docs: Do not include from kernel/rcu/srcu.c
Jonathan Corbet
maintainerPATCH 1/1 docs: Do not include from kernel/rcu/srcu.c
That file went away with commit bd8cc5a062f4 (srcu: Remove Classic SRCU) during the 4.13 merge window, leading to errors like:
Error: Cannot open file ./kernel/rcu/srcu.c
during the docs build.
---
Probably we should really put the RCU documentation into the core-API manual, but that's a change for another day.
Documentation/driver-api/basics.rst | 3 --- 1 file changed, 3 deletions(-)
Documentation/driver-api/basics.rst +0 -3
@@ -106,9 +106,6 @@ Kernel utility functions .. kernel-doc:: kernel/sys.c :export: -.. kernel-doc:: kernel/rcu/srcu.c - :export: - .. kernel-doc:: kernel/rcu/tree.c :export:
Signature · 1 line
2.9.4
Quoted 9 lines · Jonathan Corbet
That file went away with commit
bd8cc5a062f4(srcu: Remove Classic SRCU) during the 4.13 merge window, leading to errors like:Error: Cannot open file
./kernel/rcu/srcu.cduring the docs build.
Reported-by Linus Torvalds <[email protected]>Signed-off-by Jonathan Corbet <[email protected]>
Quoted 3 lines
---
Probably we should really put the RCU documentation into the core-API manual, but that's a change for another day.
Would it make sense to have checkpatch.pl to point to these files as well as to MAINTAINERS when files are added or removed? I freely confess that I have only rarely updated the kernel-doc files.
Here are the list of RCU-related files containing kernel-doc headers:
$ grep -l "/\*\*" include/linux/*rcu* kernel/rcu/* include/linux/rculist_bl.h include/linux/rculist.h include/linux/rculist_nulls.h include/linux/rcupdate.h include/linux/rcupdate_wait.h include/linux/rcu_sync.h include/linux/rcutree.h include/linux/srcu.h kernel/rcu/srcutree.c kernel/rcu/sync.c kernel/rcu/tree.c kernel/rcu/tree_exp.h kernel/rcu/tree_plugin.h kernel/rcu/update.c
Quoted 8 lines
Documentation/driver-api/basics.rst | 3 --- 1 file changed, 3 deletions(-)Documentation/driver-api/basics.rst +0
-0
Documentation/driver-api/basics.rst Kernel utility functions · line 110
Quoted 8 lines
Documentation/driver-api/basics.rst +0
-3@@ -106,9 +106,6 @@ Kernel utility functions .. kernel-doc:: kernel/sys.c :export: -.. kernel-doc:: kernel/rcu/srcu.c - :export: - .. kernel-doc:: kernel/rcu/tree.c :export:
So something like this, ignoring the Documentation/driver-api/basics.rst cleanup that would be needed (for the moment)?
Thanx, Paul
------------------------------------------------------------------------
commit 565fde68a1d3d77386ddc0e6881cf11b52ca2578
Author: Paul E. McKenney <[email protected]> Date: Tue Jul 4 14:42:20 2017 -0700
doc: Add RCU files to docbook-generation files
Documentation/core-api/kernel-api.rst +49 -0
@@ -344,3 +344,52 @@ codecs, and devices with strict requirements for interface clocking. .. kernel-doc:: include/linux/clk.h :internal: + +Synchronization Primitives +========================== + +Read-Copy Update (RCU) +---------------------- + +.. kernel-doc:: include/linux/rcupdate.h + :external: + +.. kernel-doc:: include/linux/rcupdate_wait.h + :external: + +.. kernel-doc:: include/linux/rcutree.h + :external: + +.. kernel-doc:: kernel/rcu/tree.c + :external: + +.. kernel-doc:: kernel/rcu/tree_plugin.h + :external: + +.. kernel-doc:: kernel/rcu/tree_exp.h + :external: + +.. kernel-doc:: kernel/rcu/update.c + :external: + +.. kernel-doc:: include/linux/srcu.h + :external: + +.. kernel-doc:: kernel/rcu/srcutree.c + :external: + +.. kernel-doc:: include/linux/rculist_bl.h + :external: + +.. kernel-doc:: include/linux/rculist.h + :external: + +.. kernel-doc:: include/linux/rculist_nulls.h + :external: + +.. kernel-doc:: include/linux/rcu_sync.h + :external: + +.. kernel-doc:: kernel/rcu/sync.c + :external: +