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

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

[Steven Rostedt]

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@goodmis.org>

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@timesys.com>
  *  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>

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

[Ingo Molnar]

* Steven Rostedt <rostedt@goodmis.org> wrote:

> + *  Before making any design changes to this file, please refer to
> + *  Documentation/rt-mutex-design.txt and update accordingly.

please change this to:

 + * See Documentation/rt-mutex-design.txt for details.

	Ingo

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

[Steven Rostedt]

On Wed, 2006-07-26 at 10:16 +0200, Ingo Molnar wrote:
> * Steven Rostedt <rostedt@goodmis.org> wrote:
> 
> > + *  Before making any design changes to this file, please refer to
> > + *  Documentation/rt-mutex-design.txt and update accordingly.
> 
> please change this to:
> 
>  + * See Documentation/rt-mutex-design.txt for details.

OK will do.  But I still like the idea that we imply being hit with a
wet noodle if you don't update the document ;)

-- Steve

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

[Steven Rostedt]

[V2 - update per Ingo's request]

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), and hopefully
that they will update the document if they too change the design.

-- Steve

Signed-off-by: Steven Rostedt <rostedt@goodmis.org>

Index: linux-2.6.18-rc2/kernel/rtmutex.c
===================================================================
--- linux-2.6.18-rc2.orig/kernel/rtmutex.c	2006-07-16 19:53:46.000000000 -0400
+++ linux-2.6.18-rc2/kernel/rtmutex.c	2006-07-26 08:24:14.000000000 -0400
@@ -7,6 +7,8 @@
  *  Copyright (C) 2005-2006 Timesys Corp., Thomas Gleixner <tglx@timesys.com>
  *  Copyright (C) 2005 Kihon Technologies Inc., Steven Rostedt
  *  Copyright (C) 2006 Esben Nielsen
+ *
+ *  See Documentation/rt-mutex-design.txt for details.
  */
 #include <linux/spinlock.h>
 #include <linux/module.h>

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

[Ingo Molnar]

* Steven Rostedt <rostedt@goodmis.org> wrote:

> [V2 - update per Ingo's request]
> 
> 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), and hopefully
> that they will update the document if they too change the design.
> 
> -- Steve
> 
> Signed-off-by: Steven Rostedt <rostedt@goodmis.org>

Acked-by: Ingo Molnar <mingo@elte.hu>

	Ingo