Note deprecation of old locking stuff

gnustep · May 27, 2024 · 430629b · 430629b
1 parent 1e0023d
commit 430629b
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/Documentation/ReleaseNotes.gsdoc b/Documentation/ReleaseNotes.gsdoc
@@ -73,8 +73,8 @@ notice and this notice are preserved.
 	NSURLSession many bugfixes and improvements<br>
 	NSUserDefaults fix potential deadlock<br>
 	NSXMLElement bugfix to remove previous attributes when setting attributes.<br>
-	NSXMLNode returns NSError on failure to evaluate xpath expression.
-
+	NSXMLNode returns NSError on failure to evaluate xpath expression.<br>
+	gnustep_global_lock and GSLazyLock deprecated for removal in next release.
       </section>
 
       <section>

diff --git a/Documentation/news.texi b/Documentation/news.texi
@@ -58,6 +58,7 @@ See the @url{ReleaseNotes.html} document for more information.
 @item NSUserDefaults fix potential deadlock
 @item NSXMLElement bugfix to remove previous attributes when setting attributes.
 @item NSXMLNode returns NSError on failure to evaluate xpath expression.
+@item gnustep_global_lock and GSLazyLock deprecated for removal in next release.
 
 @end itemize
 

diff --git a/Headers/Foundation/NSObject.h b/Headers/Foundation/NSObject.h
@@ -502,9 +502,8 @@ NSIncrementExtraRefCount(id anObject);
 
 #if OS_API_VERSION(GS_API_NONE, GS_API_NONE)
 
-/** Global lock to be used by classes when operating on any global
-    data that invoke other methods which also access global; thus,
-    creating the potential for deadlock. */
+/** DEPRECATED to be removed in next release.
+ */
 GS_EXPORT NSRecursiveLock *gnustep_global_lock;
 
 @interface NSObject (NEXTSTEP)

diff --git a/Headers/GNUstepBase/GSLock.h b/Headers/GNUstepBase/GSLock.h
@@ -42,6 +42,8 @@ extern "C" {
 
 @class NSNotification;
 
+/** DEPRECATED ... to be removed in next release
+ */
 GS_EXPORT_CLASS
 @interface	GSLazyLock : NSLock
 {
@@ -58,9 +60,8 @@ GS_EXPORT_CLASS
 - (void) _becomeThreaded: (NSNotification*)n;
 @end
 
-/** Global lock to be used by classes when operating on any global
-    data that invoke other methods which also access global; thus,
-    creating the potential for deadlock. */
+/** DEPRECATED ... to be removed in next release
+ */
 GS_EXPORT NSRecursiveLock *gnustep_global_lock;
 
 #if	defined(__cplusplus)

diff --git a/NEWS b/NEWS
@@ -65,6 +65,8 @@ The currently released version of the library is '1.30.0'.
    * NSXMLElement bugfix to remove previous attributes when setting
      attributes.
    * NSXMLNode returns NSError on failure to evaluate xpath expression.
+   * gnustep_global_lock and GSLazyLock deprecated for removal in next
+     release.
 
 1.2 Noteworthy changes in version '1.29.0'
 ==========================================