linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 14/14] docbook: fix sched source file names in device-drivers book
@ 2012-01-21 19:03 Randy Dunlap
  2012-01-23  8:55 ` Peter Zijlstra
  0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2012-01-21 19:03 UTC (permalink / raw)
  To: Linux Kernel Mailing List; +Cc: Linus Torvalds, Ingo Molnar, Peter Zijlstra

From: Randy Dunlap <rdunlap@xenotime.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@xenotime.net>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: Peter Zijlstra <peterz@infradead.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
 !Iinclude/linux/completion.h
 !Ekernel/timer.c
      </sect1>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH 14/14] docbook: fix sched source file names in device-drivers book
  2012-01-21 19:03 [PATCH 14/14] docbook: fix sched source file names in device-drivers book Randy Dunlap
@ 2012-01-23  8:55 ` Peter Zijlstra
  2012-01-23 17:17   ` Randy Dunlap
  0 siblings, 1 reply; 3+ messages in thread
From: Peter Zijlstra @ 2012-01-23  8:55 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: Linux Kernel Mailing List, Linus Torvalds, Ingo Molnar

On Sat, 2012-01-21 at 11:03 -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@xenotime.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@xenotime.net>
> Cc: Ingo Molnar <mingo@elte.hu>
> Cc: Peter Zijlstra <peterz@infradead.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?

Also, what the difference between Ekernel and Ikernel?

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




^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH 14/14] docbook: fix sched source file names in device-drivers book
  2012-01-23  8:55 ` Peter Zijlstra
@ 2012-01-23 17:17   ` Randy Dunlap
  0 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2012-01-23 17:17 UTC (permalink / raw)
  To: Peter Zijlstra; +Cc: Linux Kernel Mailing List, Linus Torvalds, Ingo Molnar

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@xenotime.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@xenotime.net>
>> Cc: Ingo Molnar <mingo@elte.hu>
>> Cc: Peter Zijlstra <peterz@infradead.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 ***

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2012-01-23 16:19 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-01-21 19:03 [PATCH 14/14] docbook: fix sched source file names in device-drivers book Randy Dunlap
2012-01-23  8:55 ` Peter Zijlstra
2012-01-23 17:17   ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).