From 140902a00bf4ee591d219cafa7c80770eeb46626 Mon Sep 17 00:00:00 2001
From: Richard Frith-MacDonald <rfm@gnu.org>
Date: Sun, 13 Feb 2011 20:01:46 +0000
Subject: [PATCH] add comment.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@32154 72102866-910b-0410-8b05-ffd578937521
---
 Source/NSString.m | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Source/NSString.m b/Source/NSString.m
index 4d462f65e..d1071724f 100644
--- a/Source/NSString.m
+++ b/Source/NSString.m
@@ -121,6 +121,11 @@ static NSLock			*placeholderLock;
 
 static SEL	cMemberSel = 0;
 
+/* Macro to return the receiver if it is already immutable, but an
+ * autoreleased copy otherwise.  Used where we have to return an
+ * immutable string, but we don't want to change the parameter from 
+ * a mutable string to an immutable one.
+ */
 #define	IMMUTABLE(S)	AUTORELEASE([(S) copyWithZone: NSDefaultMallocZone()])
 
 #define IS_BIT_SET(a,i) ((((a) & (1<<(i)))) > 0)