linux-kernel - Re: [PATCH 14/14] docbook: fix sched source file names in device-drivers book

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <4F1D9644.7090707@xenotime.net>
Date:	Mon, 23 Jan 2012 09:17:56 -0800
From:	Randy Dunlap <rdunlap@...otime.net>
To:	Peter Zijlstra <peterz@...radead.org>
CC:	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linus Torvalds <torvalds@...ux-foundation.org>,
	Ingo Molnar <mingo@...e.hu>
Subject: Re: [PATCH 14/14] docbook: fix sched source file names in device-drivers
 book

On 01/23/2012 12:55 AM, Peter Zijlstra wrote:
> On Sat, 2012-01-21 at 11:03 -0800, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@...otime.net>
>>
>> Fix warning since kernel scheduler functions and kernel-doc
>> notation were moved to other files.
>>
>> docproc: lnx-33-rc1/kernel/sched.c: No such file or directory
>>
>> Signed-off-by: Randy Dunlap <rdunlap@...otime.net>
>> Cc: Ingo Molnar <mingo@...e.hu>
>> Cc: Peter Zijlstra <peterz@...radead.org>
>> ---
>>  Documentation/DocBook/device-drivers.tmpl |    4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> --- lnx-33-rc1.orig/Documentation/DocBook/device-drivers.tmpl
>> +++ lnx-33-rc1/Documentation/DocBook/device-drivers.tmpl
>> @@ -50,7 +50,9 @@
>>  
>>       <sect1><title>Delaying, scheduling, and timer routines</title>
>>  !Iinclude/linux/sched.h
>> -!Ekernel/sched.c
>> +!Ekernel/sched/core.c
>> +!Ikernel/sched/cpupri.c
>> +!Ikernel/sched/fair.c
> 
> There's more files in there, they might not include proper kerneldoc
> comments, but shouldn't they be included anyway?

Only the ones that have kernel-doc comments are listed here.

> Also, what the difference between Ekernel and Ikernel?

!Efilename
is for files that contain exported symbols and it only lists the exports.
!Ifilename
is for files that contain kernel-doc for internal functions.

It is OK to use both of them for one filename so that both exports and
internal functions are listed in the generated output.

>>  !Iinclude/linux/completion.h
>>  !Ekernel/timer.c
>>       </sect1>
> 
> 
> 


-- 
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/