2007-04-25 Dick Porter <dick@ximian.com>

[mono.git] / mcs / CodingStyle

diff --git a/mcs/CodingStyle b/mcs/CodingStyle
index 43d74117a55e2ee774230289e53da143618ff600..aa78389f7b7d05d136764df67ef9e87fbc554fc5 100644 (file)
--- a/mcs/CodingStyle
+++ b/mcs/CodingStyle
@@ -25,12 +25,16 @@
        please use the attribute [MonoTODO].  This attribute can be used
        to programatically generate our status web pages:
 
-       [MonoTODO]
+       [MonoTODO("My Function is not available on Mono")]
        int MyFunction ()
        {
                throw new NotImplementedException ();
        }
 
+       Ideally, write a human description of the reason why there is
+       a MonoTODO, this will be useful in the future for our
+       automated tools that can assist in developers porting their code.
+
 * Supporting .NET 1.2, .NET 1.1 and .NET 1.0 builds
 
        The defines NET_1_1 and NET_2_0 are used to include
@@ -404,6 +408,11 @@
 
        From that point on a list of changes in a file-by-file basis,
        describing what changes were done.
+
+       This information must be cut and pasted into your commit
+       message, so the information ends up in two places: in the
+       subversion repository metadata and also on the source code
+       distirbution (which does not have the Subversion metadata).
                
 * Warnings