miscellaneous documentation patches
Subsystems (5)
These are just 3 small patches for your documentation tree.
(Also available from the for-joncorbet branch at:
git://linux-nfs.org/~bfields/linux.git for-joncorbet
if you prefer.)
--b.
PATCH 1/1 Documentation: move nfsroot.txt to filesystems/
Documentation/ is a little large, and filesystems/ seems an obvious place for this file.
Signed-off-by J. Bruce Fields <[email protected]>
--- Documentation/00-INDEX | 2 - Documentation/filesystems/00-INDEX | 2 + Documentation/filesystems/nfsroot.txt | 270 +++++++++++++++++++++++++++++++++ Documentation/kernel-parameters.txt | 6 +- Documentation/nfsroot.txt | 270 --------------------------------- fs/Kconfig | 8 +- net/ipv4/Kconfig | 8 +- net/ipv4/ipconfig.c | 2 +- 8 files changed, 284 insertions(+), 284 deletions(-) create mode 100644 Documentation/filesystems/nfsroot.txt delete mode 100644 Documentation/nfsroot.txt
Documentation/00-INDEX +0 -2
@@ -271,8 +271,6 @@ netlabel/ - directory with information on the NetLabel subsystem. networking/ - directory with info on various aspects of networking with Linux. -nfsroot.txt - - short guide on setting up a diskless box with NFS root filesystem. nmi_watchdog.txt - info on NMI watchdog for SMP systems. nommu-mmap.txt
Documentation/filesystems/00-INDEX +2 -0
@@ -66,6 +66,8 @@ mandatory-locking.txt - info on the Linux implementation of Sys V mandatory file locking. ncpfs.txt - info on Novell Netware(tm) filesystem using NCP protocol. +nfsroot.txt + - short guide on setting up a diskless box with NFS root filesystem. ntfs.txt - info and mount options for the NTFS filesystem (Windows NT). ocfs2.txt
Documentation/filesystems/nfsroot.txt new file +270 -0
270 lines not on this page · raw message
Documentation/kernel-parameters.txt +3 -3
@@ -845,7 +845,7 @@ and is between 256 and 4096 characters. It is defined in the file arch/alpha/kernel/core_marvel.c. ip= [IP_PNP] - See Documentation/nfsroot.txt. + See Documentation/filesystems/nfsroot.txt. ip2= [HW] Set IO/IRQ pairs for up to 4 IntelliPort boards See comment before ip2_setup() in
@@ -1199,10 +1199,10 @@ and is between 256 and 4096 characters. It is defined in the file file if at all. nfsaddrs= [NFS] - See Documentation/nfsroot.txt. + See Documentation/filesystems/nfsroot.txt. nfsroot= [NFS] nfs root filesystem for disk-less boxes. - See Documentation/nfsroot.txt. + See Documentation/filesystems/nfsroot.txt. nfs.callback_tcpport= [NFS] set the TCP port on which the NFSv4 callback
Documentation/nfsroot.txt deleted +0 -270
270 lines not on this page · raw message
fs/Kconfig +4 -4
@@ -1744,10 +1744,10 @@ config ROOT_NFS If you want your Linux box to mount its whole root file system (the one containing the directory /) from some other computer over the net via NFS (presumably because your box doesn't have a hard disk), - say Y. Read <file:Documentation/nfsroot.txt> for details. It is - likely that in this case, you also want to say Y to "Kernel level IP - autoconfiguration" so that your box can discover its network address - at boot time. + say Y. Read <file:Documentation/filesystems/nfsroot.txt> for + details. It is likely that in this case, you also want to say Y to + "Kernel level IP autoconfiguration" so that your box can discover + its network address at boot time. Most people say N here.
net/ipv4/Kconfig +4 -4
@@ -160,7 +160,7 @@ config IP_PNP_DHCP If unsure, say Y. Note that if you want to use DHCP, a DHCP server must be operating on your network. Read - <file:Documentation/nfsroot.txt> for details. + <file:Documentation/filesystems/nfsroot.txt> for details. config IP_PNP_BOOTP bool "IP: BOOTP support"
@@ -175,7 +175,7 @@ config IP_PNP_BOOTP does BOOTP itself, providing all necessary information on the kernel command line, you can say N here. If unsure, say Y. Note that if you want to use BOOTP, a BOOTP server must be operating on your network. - Read <file:Documentation/nfsroot.txt> for details. + Read <file:Documentation/filesystems/nfsroot.txt> for details. config IP_PNP_RARP bool "IP: RARP support"
@@ -187,8 +187,8 @@ config IP_PNP_RARP discovered automatically at boot time using the RARP protocol (an older protocol which is being obsoleted by BOOTP and DHCP), say Y here. Note that if you want to use RARP, a RARP server must be - operating on your network. Read <file:Documentation/nfsroot.txt> for - details. + operating on your network. Read + <file:Documentation/filesystems/nfsroot.txt> for details. # not yet ready.. # bool ' IP: ARP support' CONFIG_IP_PNP_ARP
net/ipv4/ipconfig.c +1 -1
@@ -1411,7 +1411,7 @@ late_initcall(ip_auto_config);/* * Decode any IP configuration options in the "ip=" or "nfsaddrs=" kernel -* command line parameter. See Documentation/nfsroot.txt. +* command line parameter. See Documentation/filesystems/nfsroot.txt. */ static int __init ic_proto_name (char *name) {
Signature · 1 line
1.5.5.rc1
PATCH 1/1 Documentation: move rpc-cache.txt to filesystems/
This file is nfs-related. (Maybe Documentation/filesystems/ would benefit from a separate nfs/ directory at some point.)
Signed-off-by J. Bruce Fields <[email protected]>
--- Documentation/00-INDEX | 2 - Documentation/filesystems/00-INDEX | 2 + Documentation/filesystems/rpc-cache.txt | 202 +++++++++++++++++++++++++++++++ Documentation/rpc-cache.txt | 202 ------------------------------- 4 files changed, 204 insertions(+), 204 deletions(-) create mode 100644 Documentation/filesystems/rpc-cache.txt delete mode 100644 Documentation/rpc-cache.txt
Documentation/00-INDEX +0 -2
@@ -319,8 +319,6 @@ robust-futexes.txt - a description of what robust futexes are. rocket.txt - info on the Comtrol RocketPort multiport serial driver. -rpc-cache.txt - - introduction to the caching mechanisms in the sunrpc layer. rt-mutex-design.txt - description of the RealTime mutex implementation design. rt-mutex.txt
Documentation/filesystems/00-INDEX +2 -0
@@ -84,6 +84,8 @@ relay.txt - info on relay, for efficient streaming from kernel to user space. romfs.txt - description of the ROMFS filesystem. +rpc-cache.txt + - introduction to the caching mechanisms in the sunrpc layer. sharedsubtree.txt - a description of shared subtrees for namespaces. smbfs.txt
Documentation/filesystems/rpc-cache.txt new file +202 -0
202 lines not on this page · raw message
Documentation/rpc-cache.txt deleted +0 -202
202 lines not on this page · raw message
Signature · 1 line
1.5.5.rc1
PATCH 1/1 Spell out behavior of atomic_dec_and_lock() in kerneldoc
A little more detail here wouldn't hurt.
Signed-off-by J. Bruce Fields <[email protected]>
--- include/linux/spinlock.h | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-)
include/linux/spinlock.h +3 -0
@@ -341,6 +341,9 @@ static inline void double_spin_unlock(spinlock_t *l1, spinlock_t *l2,* atomic_dec_and_lock - lock on reaching reference count zero * @atomic: the atomic counter * @lock: the spinlock in question +* +* Decrements @atomic by 1. If the result is 0, returns true and locks +* @lock. Returns false for all other cases. */ extern int _atomic_dec_and_lock (atomic_t *atomic,spinlock_t *lock);#define atomic_dec_and_lock (atomic, lock) \
Signature · 1 line
1.5.5.rc1
Jonathan Corbet
maintainerQuoted 1 line · J. Bruce Fields
These are just 3 small patches for your documentation tree.
Thanks; unless somebody objects I'll pull them in. I may not resubmit the tree before 2.6.25 - got travel to do and it's not urgent - but I'll definitely put it up for the next merge window.
jon
PATCH 1/1 Move sced-rt-group.txt to scheduler/
From: J. Bruce Fields <[email protected]>
Signed-off-by J. Bruce Fields <[email protected]>
--- Documentation/sched-rt-group.txt | 59 -------------------------------------- Documentation/scheduler/00-INDEX | 2 + 2 files changed, 2 insertions(+), 59 deletions(-) delete mode 100644 Documentation/sched-rt-group.txt
Quoted 7 lines · Jonathan Corbet
Quoted 1 line · J. Bruce Fields
These are just 3 small patches for your documentation tree.
Thanks; unless somebody objects I'll pull them in. I may not resubmit the tree before 2.6.25 - got travel to do and it's not urgent - but I'll definitely put it up for the next merge window.
Thanks! Oh, also, I just noticed one more. But one could probably do this all day....
--b.
Documentation/sched-rt-group.txt deleted +0 -59
@@ -1,59 +0,0 @@ - - -Real-Time group scheduling. - -The problem space: - -In order to schedule multiple groups of realtime tasks each group must -be assigned a fixed portion of the CPU time available. Without a minimum -guarantee a realtime group can obviously fall short. A fuzzy upper limit -is of no use since it cannot be relied upon. Which leaves us with just -the single fixed portion. - -CPU time is divided by means of specifying how much time can be spent -running in a given period. Say a frame fixed realtime renderer must -deliver 25 frames a second, which yields a period of 0.04s. Now say -it will also have to play some music and respond to input, leaving it -with around 80% for the graphics. We can then give this group a runtime -of 0.8 * 0.04s = 0.032s. - -This way the graphics group will have a 0.04s period with a 0.032s runtime -limit. - -Now if the audio thread needs to refill the DMA buffer every 0.005s, but -needs only about 3% CPU time to do so, it can do with a 0.03 * 0.005s -= 0.00015s. - - -The Interface: - -system wide: - -/proc/sys/kernel/sched_rt_period_ms -/proc/sys/kernel/sched_rt_runtime_us - -CONFIG_FAIR_USER_SCHED - -/sys/kernel/uids/<uid>/cpu_rt_runtime_us - -or - -CONFIG_FAIR_CGROUP_SCHED - -/cgroup/<cgroup>/cpu.rt_runtime_us - -[ time is specified in us because the interface is s32; this gives an - operating range of ~35m to 1us ] - -The period takes values in [ 1, INT_MAX ], runtime in [ -1, INT_MAX - 1 ]. - -A runtime of -1 specifies runtime == period, ie. no limit. - -New groups get the period from /proc/sys/kernel/sched_rt_period_us and -a runtime of 0. - -Settings are constrained to: - - \Sum_{i} runtime_{i} / global_period <= global_runtime / global_period - -in order to keep the configuration schedulable.
Documentation/scheduler/00-INDEX +2 -0
@@ -12,5 +12,7 @@ sched-domains.txt - information on scheduling domains. sched-nice-design.txt - How and why the scheduler's nice levels are implemented. +sched-rt-group.txt + - real-time group scheduling. sched-stats.txt - information on schedstats (Linux Scheduler Statistics).
Signature · 1 line
1.5.5.rc1
PATCH 1/1 Move sched-rt-group.txt to scheduler/
From: J. Bruce Fields <[email protected]>
Signed-off-by J. Bruce Fields <[email protected]>
--- Documentation/sched-rt-group.txt | 59 ---------------------------- Documentation/scheduler/00-INDEX | 2 + Documentation/scheduler/sched-rt-group.txt | 59 ++++++++++++++++++++++++++++ 3 files changed, 61 insertions(+), 59 deletions(-) delete mode 100644 Documentation/sched-rt-group.txt create mode 100644 Documentation/scheduler/sched-rt-group.txt
Quoted 2 lines · J. Bruce Fields
Thanks! Oh, also, I just noticed one more. But one could probably do this all day....
Err--especially if I forget to "git add" a moved file. Apologies!
--b.
Documentation/sched-rt-group.txt deleted +0 -59
@@ -1,59 +0,0 @@ - - -Real-Time group scheduling. - -The problem space: - -In order to schedule multiple groups of realtime tasks each group must -be assigned a fixed portion of the CPU time available. Without a minimum -guarantee a realtime group can obviously fall short. A fuzzy upper limit -is of no use since it cannot be relied upon. Which leaves us with just -the single fixed portion. - -CPU time is divided by means of specifying how much time can be spent -running in a given period. Say a frame fixed realtime renderer must -deliver 25 frames a second, which yields a period of 0.04s. Now say -it will also have to play some music and respond to input, leaving it -with around 80% for the graphics. We can then give this group a runtime -of 0.8 * 0.04s = 0.032s. - -This way the graphics group will have a 0.04s period with a 0.032s runtime -limit. - -Now if the audio thread needs to refill the DMA buffer every 0.005s, but -needs only about 3% CPU time to do so, it can do with a 0.03 * 0.005s -= 0.00015s. - - -The Interface: - -system wide: - -/proc/sys/kernel/sched_rt_period_ms -/proc/sys/kernel/sched_rt_runtime_us - -CONFIG_FAIR_USER_SCHED - -/sys/kernel/uids/<uid>/cpu_rt_runtime_us - -or - -CONFIG_FAIR_CGROUP_SCHED - -/cgroup/<cgroup>/cpu.rt_runtime_us - -[ time is specified in us because the interface is s32; this gives an - operating range of ~35m to 1us ] - -The period takes values in [ 1, INT_MAX ], runtime in [ -1, INT_MAX - 1 ]. - -A runtime of -1 specifies runtime == period, ie. no limit. - -New groups get the period from /proc/sys/kernel/sched_rt_period_us and -a runtime of 0. - -Settings are constrained to: - - \Sum_{i} runtime_{i} / global_period <= global_runtime / global_period - -in order to keep the configuration schedulable.
Documentation/scheduler/00-INDEX +2 -0
@@ -12,5 +12,7 @@ sched-domains.txt - information on scheduling domains. sched-nice-design.txt - How and why the scheduler's nice levels are implemented. +sched-rt-group.txt + - real-time group scheduling. sched-stats.txt - information on schedstats (Linux Scheduler Statistics).
Documentation/scheduler/sched-rt-group.txt new file +59 -0
59 lines not on this page · raw message
Signature · 1 line
1.5.5.rc1