mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-22 16:33:29 +00:00
prepare documentation for release
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@36443 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
rfm
parent
2424219d99
commit
dc9f03745e
5 changed files with 129 additions and 90 deletions
|
|
@ -1,3 +1,11 @@
|
|||
2013-03-28 Richard Frith-Macdonald <rfm@gnu.org>
|
||||
|
||||
* Documentation/ReleaseNotes.gsdoc:
|
||||
* Documentation/news.texi:
|
||||
* Headers/Foundation/NSFileManager.h:
|
||||
* Source/NSFileManager.m:
|
||||
Prepare documentation for release
|
||||
|
||||
2013-03-26 Richard Frith-Macdonald <rfm@gnu.org>
|
||||
|
||||
* Source/NSCalendar.m:
|
||||
|
|
|
|||
|
|
@ -29,6 +29,24 @@ notice and this notice are preserved.
|
|||
migrate to using a newer version of the library.
|
||||
</p>
|
||||
|
||||
<section>
|
||||
<heading>Version 1.24.4</heading>
|
||||
<p>A new stable (bugfix) release.<br />
|
||||
The main reason for this version is the inclusion of the latest
|
||||
available time zone data (something accidentally omitted from the
|
||||
previous release).<br />
|
||||
Most of the other changes in this version are fairly minor portability
|
||||
and bugfixes (and the addition of a number of new testcases).<br />
|
||||
API changes are limited to the addition of a few OSX-10.7 methods
|
||||
for NSCalendar and a few new NSFileManager methods for working
|
||||
with URLs.<br />
|
||||
Finally, there is experimental code to change the hashing algorithm
|
||||
used in the library ... enabling it will cause slower hash generation
|
||||
but a better distribution of hash values ... which might improve the
|
||||
performance of large collections.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<heading>Version 1.24.3</heading>
|
||||
<p>A new stable release.<br />
|
||||
|
|
|
|||
|
|
@ -11,6 +11,17 @@ The currently released version of the library is
|
|||
See the @url{ReleaseNotes.html} document for more information.
|
||||
@end ifclear
|
||||
|
||||
@section Noteworthy changes in version @samp{1.24.4}
|
||||
|
||||
@itemize @bullet
|
||||
@item Updated time zone data
|
||||
@item OSX 10.7 NSCalendar methods
|
||||
@item Portability improvments and minor bugfixes
|
||||
@item More testcases in the testsuite
|
||||
@end itemize
|
||||
|
||||
@ifclear ANNOUNCE-ONLY
|
||||
|
||||
@section Noteworthy changes in version @samp{1.24.3}
|
||||
|
||||
@itemize @bullet
|
||||
|
|
@ -20,8 +31,6 @@ See the @url{ReleaseNotes.html} document for more information.
|
|||
@item More explicit dependencies on external libraries.
|
||||
@end itemize
|
||||
|
||||
@ifclear ANNOUNCE-ONLY
|
||||
|
||||
@section Noteworthy changes in version @samp{1.24.0}
|
||||
|
||||
@itemize @bullet
|
||||
|
|
|
|||
|
|
@ -215,29 +215,82 @@ typedef uint32_t OSType;
|
|||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a shared default file manager which may be used throughout an
|
||||
* application.
|
||||
*/
|
||||
+ (NSFileManager*) defaultManager;
|
||||
|
||||
#if OS_API_VERSION(MAC_OS_X_VERSION_10_5, GS_API_LATEST)
|
||||
- (NSDictionary *) attributesOfItemAtPath: (NSString*)path
|
||||
error: (NSError**)error;
|
||||
|
||||
/**
|
||||
* Copies the item specified by the src path to the
|
||||
* location specified by the dst path. If the src is a directory,
|
||||
* it is copied recursively with all of its contents.<br />
|
||||
* Errors are returned in the error variable.
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) copyItemAtPath: (NSString*)src
|
||||
toPath: (NSString*)dst
|
||||
error: (NSError**)error;
|
||||
/**
|
||||
* Moves a file or directory specified by src to
|
||||
* its destination specified by dst, errors are
|
||||
* returned in error.<br />
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) moveItemAtPath: (NSString*)src
|
||||
toPath: (NSString*)dst
|
||||
error: (NSError**)error;
|
||||
|
||||
/**
|
||||
* Removes the file or directory specified by the path
|
||||
* to be removed. If the path points to a directory,
|
||||
* the directory is deleted recursively.<br />
|
||||
* Returns YES on success, otherwise NO.
|
||||
*/
|
||||
- (BOOL) removeItemAtPath: (NSString*)path
|
||||
error: (NSError**)error;
|
||||
|
||||
/**
|
||||
* Copies the a file or directory specified by the src URL to the
|
||||
* location specified by the dst URL. If the src is a directory,
|
||||
* it is copied recursively with all of its contents.<br />
|
||||
* Errors are returned in the error variable.
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) copyItemAtURL: (NSURL*)src
|
||||
toURL: (NSURL*)dst
|
||||
error: (NSError**)error;
|
||||
|
||||
/**
|
||||
* Moves a file or directory specified by src to
|
||||
* its destination specified by dst, errors are
|
||||
* returned in error.<br />
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) moveItemAtURL: (NSURL*)src
|
||||
toURL: (NSURL*)dst
|
||||
error: (NSError**)error;
|
||||
- (BOOL) removeItemAtURL: (NSURL*)path
|
||||
/**
|
||||
* Removes the file or directory specified by the url
|
||||
* to be removed. If the url points to a directory,
|
||||
* the directory is deleted recursively.<br />
|
||||
* Returns YES on success, otherwise NO.
|
||||
*/
|
||||
- (BOOL) removeItemAtURL: (NSURL*)url
|
||||
error: (NSError**)error;
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Changes the current directory used for all subsequent operations.<br />
|
||||
* All non-absolute paths are interpreted relative to this directory.<br />
|
||||
* The current directory is set on a per-task basis, so the current
|
||||
* directory for other file manager instances will also be changed
|
||||
* by this method.
|
||||
*/
|
||||
- (BOOL) changeCurrentDirectoryPath: (NSString*)path;
|
||||
- (BOOL) changeFileAttributes: (NSDictionary*)attributes
|
||||
atPath: (NSString*)path;
|
||||
|
|
@ -293,7 +346,17 @@ typedef uint32_t OSType;
|
|||
- (NSDictionary*) fileAttributesAtPath: (NSString*)path
|
||||
traverseLink: (BOOL)flag;
|
||||
|
||||
/**
|
||||
* Returns YES if a file (or directory etc) exists at the specified path.
|
||||
*/
|
||||
- (BOOL) fileExistsAtPath: (NSString*)path;
|
||||
|
||||
/**
|
||||
* Returns YES if a file (or directory etc) exists at the specified path.<br />
|
||||
* If the isDirectory argument is not a nul pointer, stores a flag
|
||||
* in the location it points to, indicating whether the file is a
|
||||
* directory or not.<br />
|
||||
*/
|
||||
- (BOOL) fileExistsAtPath: (NSString*)path isDirectory: (BOOL*)isDirectory;
|
||||
- (NSDictionary*) fileSystemAttributesAtPath: (NSString*)path;
|
||||
|
||||
|
|
@ -321,6 +384,14 @@ typedef uint32_t OSType;
|
|||
toPath: (NSString*)destination
|
||||
handler: (id)handler;
|
||||
- (NSString*) pathContentOfSymbolicLinkAtPath: (NSString*)path;
|
||||
|
||||
/**
|
||||
* Removes the file or directory at path, using a
|
||||
* handler object which should respond to
|
||||
* [NSObject(NSFileManagerHandler)-fileManager:willProcessPath:] and
|
||||
* [NSObject(NSFileManagerHandler)-fileManager:shouldProceedAfterError:]
|
||||
* messages.
|
||||
*/
|
||||
- (BOOL) removeFileAtPath: (NSString*)path
|
||||
handler: (id)handler;
|
||||
|
||||
|
|
|
|||
|
|
@ -321,10 +321,6 @@ static Class GSAttrDictionaryClass = 0;
|
|||
static NSFileManager* defaultManager = nil;
|
||||
static NSStringEncoding defaultEncoding;
|
||||
|
||||
/**
|
||||
* Returns a shared default file manager which may be used throughout an
|
||||
* application.
|
||||
*/
|
||||
+ (NSFileManager*) defaultManager
|
||||
{
|
||||
if (defaultManager == nil)
|
||||
|
|
@ -361,13 +357,6 @@ static NSStringEncoding defaultEncoding;
|
|||
[super dealloc];
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the current directory used for all subsequent operations.<br />
|
||||
* All non-absolute paths are interpreted relative to this directory.<br />
|
||||
* The current directory is set on a per-task basis, so the current
|
||||
* directory for other file manager instances will also be changed
|
||||
* by this method.
|
||||
*/
|
||||
- (BOOL) changeCurrentDirectoryPath: (NSString*)path
|
||||
{
|
||||
static Class bundleClass = 0;
|
||||
|
|
@ -1126,27 +1115,6 @@ static NSStringEncoding defaultEncoding;
|
|||
return YES;
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies the a file or directory specified by the <i>src</i> URL to the
|
||||
* location specified by the <i>dst</i> URL. If the <i>src</i> is a directory,
|
||||
* it is copied recursively with all of its contents.<br />
|
||||
* Errors are returned in the <i>error</i> variable.
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) copyItemAtURL: (NSURL*)src
|
||||
toURL: (NSURL*)dst
|
||||
error: (NSError**)error
|
||||
{
|
||||
return [self copyItemAtPath: [src path] toPath: [dst path] error: error];
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies the item specified by the <i>src</i> path to the
|
||||
* location specified by the <i>dst</i> path. If the <i>src</i> is a directory,
|
||||
* it is copied recursively with all of its contents.<br />
|
||||
* Errors are returned in the <i>error</i> variable.
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) copyItemAtPath: (NSString*)src
|
||||
toPath: (NSString*)dst
|
||||
error: (NSError**)error
|
||||
|
|
@ -1167,6 +1135,13 @@ static NSStringEncoding defaultEncoding;
|
|||
return result;
|
||||
}
|
||||
|
||||
- (BOOL) copyItemAtURL: (NSURL*)src
|
||||
toURL: (NSURL*)dst
|
||||
error: (NSError**)error
|
||||
{
|
||||
return [self copyItemAtPath: [src path] toPath: [dst path] error: error];
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the file or directory at source to destination, using a
|
||||
* handler object which should respond to
|
||||
|
|
@ -1254,25 +1229,6 @@ static NSStringEncoding defaultEncoding;
|
|||
return NO;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves a file or directory specified by <i>src</i> to
|
||||
* its destination specified by <i>dst</i>, errors are
|
||||
* returned in <i>error</i>.<br />
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) moveItemAtURL: (NSURL*)src
|
||||
toURL: (NSURL*)dst
|
||||
error: (NSError**)error
|
||||
{
|
||||
return [self moveItemAtPath: [src path] toPath: [dst path] error: error];
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves a file or directory specified by <i>src</i> to
|
||||
* its destination specified by <i>dst</i>, errors are
|
||||
* returned in <i>error</i>.<br />
|
||||
* Returns YES on success, NO otherwise.
|
||||
*/
|
||||
- (BOOL) moveItemAtPath: (NSString*)src
|
||||
toPath: (NSString*)dst
|
||||
error: (NSError**)error
|
||||
|
|
@ -1293,6 +1249,13 @@ static NSStringEncoding defaultEncoding;
|
|||
return result;
|
||||
}
|
||||
|
||||
- (BOOL) moveItemAtURL: (NSURL*)src
|
||||
toURL: (NSURL*)dst
|
||||
error: (NSError**)error
|
||||
{
|
||||
return [self moveItemAtPath: [src path] toPath: [dst path] error: error];
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Links the file or directory at source to destination, using a
|
||||
* handler object which should respond to
|
||||
|
|
@ -1402,13 +1365,6 @@ static NSStringEncoding defaultEncoding;
|
|||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the file or directory at path, using a
|
||||
* handler object which should respond to
|
||||
* [NSObject(NSFileManagerHandler)-fileManager:willProcessPath:] and
|
||||
* [NSObject(NSFileManagerHandler)-fileManager:shouldProceedAfterError:]
|
||||
* messages.
|
||||
*/
|
||||
- (BOOL) removeFileAtPath: (NSString*)path
|
||||
handler: handler
|
||||
{
|
||||
|
|
@ -1516,26 +1472,6 @@ static NSStringEncoding defaultEncoding;
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Removes the file or directory specified by the <i>url</i>
|
||||
* to be removed. If the <i>url</i> points to a directory,
|
||||
* the directory is deleted recursively.<br />
|
||||
* Returns YES on success, otherwise NO.
|
||||
*/
|
||||
- (BOOL) removeItemAtURL: (NSURL*)url
|
||||
error: (NSError**)error
|
||||
{
|
||||
return [self removeItemAtPath: [url path] error: error];
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the file or directory specified by the <i>path</i>
|
||||
* to be removed. If the <i>path</i> points to a directory,
|
||||
* the directory is deleted recursively.<br />
|
||||
* Returns YES on success, otherwise NO.
|
||||
*/
|
||||
- (BOOL) removeItemAtPath: (NSString*)path
|
||||
error: (NSError**)error
|
||||
{
|
||||
|
|
@ -1555,20 +1491,17 @@ static NSStringEncoding defaultEncoding;
|
|||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns YES if a file (or directory etc) exists at the specified path.
|
||||
*/
|
||||
- (BOOL) removeItemAtURL: (NSURL*)url
|
||||
error: (NSError**)error
|
||||
{
|
||||
return [self removeItemAtPath: [url path] error: error];
|
||||
}
|
||||
|
||||
- (BOOL) fileExistsAtPath: (NSString*)path
|
||||
{
|
||||
return [self fileExistsAtPath: path isDirectory: 0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns YES if a file (or directory etc) exists at the specified path.<br />
|
||||
* If the isDirectory argument is not a nul pointer, stores a flag
|
||||
* in the location it points to, indicating whether the file is a
|
||||
* directory or not.<br />
|
||||
*/
|
||||
- (BOOL) fileExistsAtPath: (NSString*)path isDirectory: (BOOL*)isDirectory
|
||||
{
|
||||
const _CHAR *lpath = [self fileSystemRepresentationWithPath: path];
|
||||
|
|
|
|||
Loading…
Reference in a new issue