[PATCH] reference rt-mutex-design in rtmutex.c

From: Steven Rostedt
Date: Fri Jul 21 2006 - 09:46:19 EST



In order to prevent Doc Rot, this patch adds a reference to the design
document for rtmutex.c in rtmutex.c. So when someone needs to update or
change the design of that file they will know that a document actually
exists that explains the design (helping them change it), as well as
letting them know that they need to update it if it becomes out of date.

-- Steve

Signed-off-by: Steven Rostedt <rostedt@xxxxxxxxxxx>

Index: linux-2.6.18-rc2/kernel/rtmutex.c
===================================================================
--- linux-2.6.18-rc2.orig/kernel/rtmutex.c 2006-07-21 09:38:08.000000000 -0400
+++ linux-2.6.18-rc2/kernel/rtmutex.c 2006-07-21 09:36:05.000000000 -0400
@@ -7,6 +7,9 @@
* Copyright (C) 2005-2006 Timesys Corp., Thomas Gleixner <tglx@xxxxxxxxxxx>
* Copyright (C) 2005 Kihon Technologies Inc., Steven Rostedt
* Copyright (C) 2006 Esben Nielsen
+ *
+ * Before making any design changes to this file, please refer to
+ * Documentation/rt-mutex-design.txt and update accordingly.
*/
#include <linux/spinlock.h>
#include <linux/module.h>
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/