docbook: fix sched source file names in device-drivers book

PATCH Applied Randy Dunlap 2 participants 3 messages Jan 21, 2012 – Jan 23, 2012 Documentation

lore

Share & tools

lore

Randy Dunlap

author

2012-01-21 18:05 UTC #0 lore raw

PATCH 14/14 docbook: fix sched source file names in device-drivers book

From: Randy Dunlap <[email protected]>

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 <[email protected]>

Cc Ingo Molnar <[email protected]>

Cc Peter Zijlstra <[email protected]>

---
 Documentation/DocBook/device-drivers.tmpl |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Documentation/DocBook/device-drivers.tmpl +3 -1

@@ -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>

Peter Zijlstra

2012-01-23 08:55 UTC #1 lore raw

Quoted 17 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>
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 <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Peter Zijlstra <[email protected]>
---
 Documentation/DocBook/device-drivers.tmpl |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Documentation/DocBook/device-drivers.tmpl line 55

Quoted 7 lines

Documentation/DocBook/device-drivers.tmpl +3 -1

@@ -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?

Quoted 3 lines

Documentation/DocBook/device-drivers.tmpl +0 -0
 !Iinclude/linux/completion.h
 !Ekernel/timer.c
      </sect1>

Randy Dunlap

author

2012-01-23 16:19 UTC #2 lore raw

Quoted 19 lines · Peter Zijlstra

Quoted 18 lines · Randy Dunlap
From: Randy Dunlap <[email protected]>
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 <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Peter Zijlstra <[email protected]>
---
 Documentation/DocBook/device-drivers.tmpl |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/DocBook/device-drivers.tmpl +0 -0
@@ -50,7 +50,9 @@
 

Quoted 9 lines

Documentation/DocBook/device-drivers.tmpl line 55
Quoted 6 lines
Documentation/DocBook/device-drivers.tmpl +3 -1
      <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.

Quoted 1 line

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.

Quoted 6 lines

Quoted 3 lines
Documentation/DocBook/device-drivers.tmpl +0 -0
 !Iinclude/linux/completion.h
 !Ekernel/timer.c
      </sect1>

Signature · 2 lines

~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***