Commit 14897e35 authored by Linus Torvalds's avatar Linus Torvalds

Merge branch 'docs' of git://git.lwn.net/linux-2.6

* 'docs' of git://git.lwn.net/linux-2.6:
  Add additional examples in Documentation/spinlocks.txt
  Move sched-rt-group.txt to scheduler/
  Documentation: move rpc-cache.txt to filesystems/
  Documentation: move nfsroot.txt to filesystems/
  Spell out behavior of atomic_dec_and_lock() in kerneldoc
  Fix a typo in highres.txt
  Fixes to the seq_file document
  Fill out information on patch tags in SubmittingPatches
  Add the seq_file documentation
parents b0fac023 14dadf1d
...@@ -271,8 +271,6 @@ netlabel/ ...@@ -271,8 +271,6 @@ netlabel/
- directory with information on the NetLabel subsystem. - directory with information on the NetLabel subsystem.
networking/ networking/
- directory with info on various aspects of networking with Linux. - 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 nmi_watchdog.txt
- info on NMI watchdog for SMP systems. - info on NMI watchdog for SMP systems.
nommu-mmap.txt nommu-mmap.txt
...@@ -321,8 +319,6 @@ robust-futexes.txt ...@@ -321,8 +319,6 @@ robust-futexes.txt
- a description of what robust futexes are. - a description of what robust futexes are.
rocket.txt rocket.txt
- info on the Comtrol RocketPort multiport serial driver. - info on the Comtrol RocketPort multiport serial driver.
rpc-cache.txt
- introduction to the caching mechanisms in the sunrpc layer.
rt-mutex-design.txt rt-mutex-design.txt
- description of the RealTime mutex implementation design. - description of the RealTime mutex implementation design.
rt-mutex.txt rt-mutex.txt
......
...@@ -328,7 +328,7 @@ now, but you can do this to mark internal company procedures or just ...@@ -328,7 +328,7 @@ now, but you can do this to mark internal company procedures or just
point out some special detail about the sign-off. point out some special detail about the sign-off.
13) When to use Acked-by: 13) When to use Acked-by: and Cc:
The Signed-off-by: tag indicates that the signer was involved in the The Signed-off-by: tag indicates that the signer was involved in the
development of the patch, or that he/she was in the patch's delivery path. development of the patch, or that he/she was in the patch's delivery path.
...@@ -349,11 +349,59 @@ Acked-by: does not necessarily indicate acknowledgement of the entire patch. ...@@ -349,11 +349,59 @@ Acked-by: does not necessarily indicate acknowledgement of the entire patch.
For example, if a patch affects multiple subsystems and has an Acked-by: from For example, if a patch affects multiple subsystems and has an Acked-by: from
one subsystem maintainer then this usually indicates acknowledgement of just one subsystem maintainer then this usually indicates acknowledgement of just
the part which affects that maintainer's code. Judgement should be used here. the part which affects that maintainer's code. Judgement should be used here.
When in doubt people should refer to the original discussion in the mailing When in doubt people should refer to the original discussion in the mailing
list archives. list archives.
If a person has had the opportunity to comment on a patch, but has not
provided such comments, you may optionally add a "Cc:" tag to the patch.
This is the only tag which might be added without an explicit action by the
person it names. This tag documents that potentially interested parties
have been included in the discussion
14) The canonical patch format
14) Using Test-by: and Reviewed-by:
A Tested-by: tag indicates that the patch has been successfully tested (in
some environment) by the person named. This tag informs maintainers that
some testing has been performed, provides a means to locate testers for
future patches, and ensures credit for the testers.
Reviewed-by:, instead, indicates that the patch has been reviewed and found
acceptable according to the Reviewer's Statement:
Reviewer's statement of oversight
By offering my Reviewed-by: tag, I state that:
(a) I have carried out a technical review of this patch to
evaluate its appropriateness and readiness for inclusion into
the mainline kernel.
(b) Any problems, concerns, or questions relating to the patch
have been communicated back to the submitter. I am satisfied
with the submitter's response to my comments.
(c) While there may be things that could be improved with this
submission, I believe that it is, at this time, (1) a
worthwhile modification to the kernel, and (2) free of known
issues which would argue against its inclusion.
(d) While I have reviewed the patch and believe it to be sound, I
do not (unless explicitly stated elsewhere) make any
warranties or guarantees that it will achieve its stated
purpose or function properly in any given situation.
A Reviewed-by tag is a statement of opinion that the patch is an
appropriate modification of the kernel without any remaining serious
technical issues. Any interested reviewer (who has done the work) can
offer a Reviewed-by tag for a patch. This tag serves to give credit to
reviewers and to inform maintainers of the degree of review which has been
done on the patch. Reviewed-by: tags, when supplied by reviewers known to
understand the subject area and to perform thorough reviews, will normally
increase the liklihood of your patch getting into the kernel.
15) The canonical patch format
The canonical patch subject line is: The canonical patch subject line is:
......
...@@ -66,6 +66,8 @@ mandatory-locking.txt ...@@ -66,6 +66,8 @@ mandatory-locking.txt
- info on the Linux implementation of Sys V mandatory file locking. - info on the Linux implementation of Sys V mandatory file locking.
ncpfs.txt ncpfs.txt
- info on Novell Netware(tm) filesystem using NCP protocol. - 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 ntfs.txt
- info and mount options for the NTFS filesystem (Windows NT). - info and mount options for the NTFS filesystem (Windows NT).
ocfs2.txt ocfs2.txt
...@@ -82,6 +84,10 @@ relay.txt ...@@ -82,6 +84,10 @@ relay.txt
- info on relay, for efficient streaming from kernel to user space. - info on relay, for efficient streaming from kernel to user space.
romfs.txt romfs.txt
- description of the ROMFS filesystem. - description of the ROMFS filesystem.
rpc-cache.txt
- introduction to the caching mechanisms in the sunrpc layer.
seq_file.txt
- how to use the seq_file API
sharedsubtree.txt sharedsubtree.txt
- a description of shared subtrees for namespaces. - a description of shared subtrees for namespaces.
smbfs.txt smbfs.txt
......
This diff is collapsed.
...@@ -98,7 +98,7 @@ System-level global event devices are used for the Linux periodic tick. Per-CPU ...@@ -98,7 +98,7 @@ System-level global event devices are used for the Linux periodic tick. Per-CPU
event devices are used to provide local CPU functionality such as process event devices are used to provide local CPU functionality such as process
accounting, profiling, and high resolution timers. accounting, profiling, and high resolution timers.
The management layer assignes one or more of the folliwing functions to a clock The management layer assigns one or more of the following functions to a clock
event device: event device:
- system global periodic tick (jiffies update) - system global periodic tick (jiffies update)
- cpu local update_process_times - cpu local update_process_times
......
...@@ -844,7 +844,7 @@ and is between 256 and 4096 characters. It is defined in the file ...@@ -844,7 +844,7 @@ and is between 256 and 4096 characters. It is defined in the file
arch/alpha/kernel/core_marvel.c. arch/alpha/kernel/core_marvel.c.
ip= [IP_PNP] ip= [IP_PNP]
See Documentation/nfsroot.txt. See Documentation/filesystems/nfsroot.txt.
ip2= [HW] Set IO/IRQ pairs for up to 4 IntelliPort boards ip2= [HW] Set IO/IRQ pairs for up to 4 IntelliPort boards
See comment before ip2_setup() in See comment before ip2_setup() in
...@@ -1198,10 +1198,10 @@ and is between 256 and 4096 characters. It is defined in the file ...@@ -1198,10 +1198,10 @@ and is between 256 and 4096 characters. It is defined in the file
file if at all. file if at all.
nfsaddrs= [NFS] nfsaddrs= [NFS]
See Documentation/nfsroot.txt. See Documentation/filesystems/nfsroot.txt.
nfsroot= [NFS] nfs root filesystem for disk-less boxes. nfsroot= [NFS] nfs root filesystem for disk-less boxes.
See Documentation/nfsroot.txt. See Documentation/filesystems/nfsroot.txt.
nfs.callback_tcpport= nfs.callback_tcpport=
[NFS] set the TCP port on which the NFSv4 callback [NFS] set the TCP port on which the NFSv4 callback
......
...@@ -12,5 +12,7 @@ sched-domains.txt ...@@ -12,5 +12,7 @@ sched-domains.txt
- information on scheduling domains. - information on scheduling domains.
sched-nice-design.txt sched-nice-design.txt
- How and why the scheduler's nice levels are implemented. - How and why the scheduler's nice levels are implemented.
sched-rt-group.txt
- real-time group scheduling.
sched-stats.txt sched-stats.txt
- information on schedstats (Linux Scheduler Statistics). - information on schedstats (Linux Scheduler Statistics).
...@@ -5,6 +5,28 @@ Please use DEFINE_SPINLOCK()/DEFINE_RWLOCK() or ...@@ -5,6 +5,28 @@ Please use DEFINE_SPINLOCK()/DEFINE_RWLOCK() or
__SPIN_LOCK_UNLOCKED()/__RW_LOCK_UNLOCKED() as appropriate for static __SPIN_LOCK_UNLOCKED()/__RW_LOCK_UNLOCKED() as appropriate for static
initialization. initialization.
Most of the time, you can simply turn:
static spinlock_t xxx_lock = SPIN_LOCK_UNLOCKED;
into:
static DEFINE_SPINLOCK(xxx_lock);
Static structure member variables go from:
struct foo bar {
.lock = SPIN_LOCK_UNLOCKED;
};
to:
struct foo bar {
.lock = __SPIN_LOCK_UNLOCKED(bar.lock);
};
Declaration of static rw_locks undergo a similar transformation.
Dynamic initialization, when necessary, may be performed as Dynamic initialization, when necessary, may be performed as
demonstrated below. demonstrated below.
......
...@@ -1744,10 +1744,10 @@ config ROOT_NFS ...@@ -1744,10 +1744,10 @@ config ROOT_NFS
If you want your Linux box to mount its whole root file system (the If you want your Linux box to mount its whole root file system (the
one containing the directory /) from some other computer over the one containing the directory /) from some other computer over the
net via NFS (presumably because your box doesn't have a hard disk), net via NFS (presumably because your box doesn't have a hard disk),
say Y. Read <file:Documentation/nfsroot.txt> for details. It is say Y. Read <file:Documentation/filesystems/nfsroot.txt> for
likely that in this case, you also want to say Y to "Kernel level IP details. It is likely that in this case, you also want to say Y to
autoconfiguration" so that your box can discover its network address "Kernel level IP autoconfiguration" so that your box can discover
at boot time. its network address at boot time.
Most people say N here. Most people say N here.
......
...@@ -341,6 +341,9 @@ static inline void double_spin_unlock(spinlock_t *l1, spinlock_t *l2, ...@@ -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_dec_and_lock - lock on reaching reference count zero
* @atomic: the atomic counter * @atomic: the atomic counter
* @lock: the spinlock in question * @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); extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock);
#define atomic_dec_and_lock(atomic, lock) \ #define atomic_dec_and_lock(atomic, lock) \
......
...@@ -160,7 +160,7 @@ config IP_PNP_DHCP ...@@ -160,7 +160,7 @@ config IP_PNP_DHCP
If unsure, say Y. Note that if you want to use DHCP, a DHCP server If unsure, say Y. Note that if you want to use DHCP, a DHCP server
must be operating on your network. Read must be operating on your network. Read
<file:Documentation/nfsroot.txt> for details. <file:Documentation/filesystems/nfsroot.txt> for details.
config IP_PNP_BOOTP config IP_PNP_BOOTP
bool "IP: BOOTP support" bool "IP: BOOTP support"
...@@ -175,7 +175,7 @@ config IP_PNP_BOOTP ...@@ -175,7 +175,7 @@ config IP_PNP_BOOTP
does BOOTP itself, providing all necessary information on the kernel 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 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. 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 config IP_PNP_RARP
bool "IP: RARP support" bool "IP: RARP support"
...@@ -187,8 +187,8 @@ config IP_PNP_RARP ...@@ -187,8 +187,8 @@ config IP_PNP_RARP
discovered automatically at boot time using the RARP protocol (an discovered automatically at boot time using the RARP protocol (an
older protocol which is being obsoleted by BOOTP and DHCP), say Y 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 here. Note that if you want to use RARP, a RARP server must be
operating on your network. Read <file:Documentation/nfsroot.txt> for operating on your network. Read
details. <file:Documentation/filesystems/nfsroot.txt> for details.
# not yet ready.. # not yet ready..
# bool ' IP: ARP support' CONFIG_IP_PNP_ARP # bool ' IP: ARP support' CONFIG_IP_PNP_ARP
......
...@@ -1411,7 +1411,7 @@ late_initcall(ip_auto_config); ...@@ -1411,7 +1411,7 @@ late_initcall(ip_auto_config);
/* /*
* Decode any IP configuration options in the "ip=" or "nfsaddrs=" kernel * 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) static int __init ic_proto_name(char *name)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment