From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752413AbdGDVoE (ORCPT ); Tue, 4 Jul 2017 17:44:04 -0400 Received: from mx0a-001b2d01.pphosted.com ([148.163.156.1]:33132 "EHLO mx0a-001b2d01.pphosted.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752204AbdGDVoD (ORCPT ); Tue, 4 Jul 2017 17:44:03 -0400 Date: Tue, 4 Jul 2017 14:44:00 -0700 From: "Paul E. McKenney" To: Jonathan Corbet Cc: LKML , linux-doc@vger.kernel.org Subject: Re: [PATCH] docs: Do not include from kernel/rcu/srcu.c Reply-To: paulmck@linux.vnet.ibm.com References: <20170704132647.7aa89db8@lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20170704132647.7aa89db8@lwn.net> User-Agent: Mutt/1.5.21 (2010-09-15) X-TM-AS-GCONF: 00 x-cbid: 17070421-2213-0000-0000-000001F0A49E X-IBM-SpamModules-Scores: X-IBM-SpamModules-Versions: BY=3.00007320; HX=3.00000241; KW=3.00000007; PH=3.00000004; SC=3.00000214; SDB=6.00882885; UDB=6.00440387; IPR=6.00663076; BA=6.00005453; NDR=6.00000001; ZLA=6.00000005; ZF=6.00000009; ZB=6.00000000; ZP=6.00000000; ZH=6.00000000; ZU=6.00000002; MB=3.00016083; XFM=3.00000015; UTC=2017-07-04 21:44:01 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 17070421-2214-0000-0000-000056C10192 Message-Id: <20170704214400.GO2393@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:,, definitions=2017-07-04_13:,, signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 suspectscore=0 malwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1703280000 definitions=main-1707040371 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Tue, Jul 04, 2017 at 01:26:47PM -0600, Jonathan Corbet wrote: > 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. > > Reported-by: Linus Torvalds > Signed-off-by: Jonathan Corbet Acked-by: Paul E. McKenney > --- > 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 > Documentation/driver-api/basics.rst | 3 --- > 1 file changed, 3 deletions(-) > > diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst > index 472e7a664d13..ab82250c7727 100644 > --- a/Documentation/driver-api/basics.rst > +++ b/Documentation/driver-api/basics.rst > @@ -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 Date: Tue Jul 4 14:42:20 2017 -0700 doc: Add RCU files to docbook-generation files Suggested-by: Jonathan Corbet Signed-off-by: Paul E. McKenney diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst index 9ec8488319dc..252452dc5ffd 100644 --- a/Documentation/core-api/kernel-api.rst +++ b/Documentation/core-api/kernel-api.rst @@ -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: +