Regenerate top level docs

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/branches/stable@24367 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2007-01-16 06:45:33 +00:00
parent e39553dfd5
commit 5c21b4d221
4 changed files with 192 additions and 161 deletions

View file

@ -1,10 +1,14 @@
Announcement
************
1 Announcement
**************
The GNUstep Base Library, version 1.13.0, is now available.
ftp.gnustep.org
What is the GNUstep Base Library?
=================================
pub/daily-snapshots
The GNUstep Base Library, version 1.13.1, is now available.
1.1 What is the GNUstep Base Library?
=====================================
The GNUstep Base Library is a library of general-purpose, non-graphical
Objective C objects. For example, it includes classes for strings,
@ -18,21 +22,27 @@ portion of the OpenStep standard (the Foundation library).
There is more information available at the GNUstep homepage at
`http://www.gnustep.org'.
Noteworthy changes in version `1.13.0'
======================================
ftp.gnustep.org
Several sets of classes have been added for dealing with urls and
predicates. A few minor api changes have occured as well. See the
release notes for more details.
pub/daily-snapshots
Where can you get it? How can you compile it?
==============================================
1.2 Noteworthy changes in version `1.13.1'
==========================================
The gnustep-base-1.13.0.tar.gz distribution file has been placed at
<ftp://ftp.gnustep.org/pub/gnustep/core>.
Various minor bugs and MacOS-X incompatibilities fixed. One important
fix for a possible buffer overrun attack when initialising NSDate
objects from strings. One fix for a serious (crash) bug when
initialising the bundles system in an application which has a lot of
frameworks linked to it. See the release notes for more details.
1.3 Where can you get it? How can you compile it?
==================================================
The gnustep-base-1.13.1.tar.gz distribution file has been placed at
`ftp://ftp.gnustep.org/pub/gnustep/core'.
Please log bug reports on the GNUstep project page
<http://savannah.gnu.org/bugs/?group=gnustep> or send bug reports to
`http://savannah.gnu.org/bugs/?group=gnustep' or send bug reports to
<bug-gnustep@gnu.org>.
Copyright (C) 2005 Free Software Foundation

38
INSTALL
View file

@ -1,11 +1,15 @@
Introduction
============
ftp.gnustep.org
pub/daily-snapshots
0.1 Introduction
================
If you are installing this package as part of the GNUstep core packages,
read the file GNUstep-HOWTO for more complete instructions on how to
install the entire GNUstep package (including this library).
GNUstep-HOWTO is located in the gnustep-make package or at
<http://www.gnustep.org>
`http://www.gnustep.org'
Other external libraries that you may need to install include:
@ -44,8 +48,8 @@ configure are described below.
make
make install
Configuration
=============
0.2 Configuration
=================
Configuration is performed by running the `configure' program at a
shell prompt. You may want to use some of the optional arguments to the
@ -63,10 +67,10 @@ packages, just to make sure.
Also make sure you've read the machine-specific instructions for your
particular operating system and CPU. These instructions come with the
GNUstep-HOWTO and are also located at the GNUstep web site at
<http://www.gnustep.org>.
`http://www.gnustep.org'.
Reading Command-Line Arguments
------------------------------
0.2.1 Reading Command-Line Arguments
------------------------------------
There are two features that change how GNUstep gets access to
command-line arguments and environment variables (normally passed to
@ -99,8 +103,8 @@ to pass the program arguments to NSProcessInfo (This would be done
automatically if you use the NSApplicationMain function in a gui
application).
FFI Library
-----------
0.2.2 FFI Library
-----------------
GNUstep's NSInvocations and Distributed Objects code involves detailed
manipulation of the stack and function calls using a library that
@ -113,11 +117,11 @@ handling, but this rarely works on non-ix86 machines and is not
supported.
You need to have the ffcall libraries, which you can get from
<ftp://www.gnustep.org/pub/gnustep/libs/> or
<http://clisp.cons.org/~haible/>. You also need to have a special
`ftp://www.gnustep.org/pub/gnustep/libs/' or
`http://clisp.cons.org/~haible/'. You also need to have a special
version of the Objective-C library if you are not using gcc 3.x (before
gcc 3.0 the required hooks were not in the standard library). You can
get this library from <ftp://www.gnustep.org/pub/gnustep/libs>.
get this library from `ftp://www.gnustep.org/pub/gnustep/libs'.
Support for the libffi library has also been added. Current versions
of libffi are only distributed with gcc version 3.x, although it is not
@ -133,8 +137,8 @@ something like:
To enable this in the gnustep-base library, use the configure option
`--enable-libffi'.
OpenSSL
-------
0.2.3 OpenSSL
-------------
GNUstep base has optional support for using the OpenSSL libraries for
secure URL connections (with the NSURL classes). This functionality is
@ -144,8 +148,8 @@ replacement, it can quickly be used by creating another bundle. The
openssl libraries need to be installed for this to work. To disable
this option add `--disable-openssl' when running the `configure' script.
Compilation
===========
0.3 Compilation
===============
To compile this library, type make. After this is complete, type make
install (make sure you are the root user). Some additional options you

240
NEWS
View file

@ -1,19 +1,31 @@
News
****
ftp.gnustep.org
The currently released version of the library is `1.13.0'.
pub/daily-snapshots
See the <ReleaseNotes.html> document for more information.
1 News
******
Noteworthy changes in version `1.13.0'
======================================
The currently released version of the library is `1.13.1'.
See the `ReleaseNotes.html' document for more information.
1.1 Noteworthy changes in version `1.13.1'
==========================================
Various minor bugs and MacOS-X incompatibilities fixed. One important
fix for a possible buffer overrun attack when initialising NSDate
objects from strings. One fix for a serious (crash) bug when
initialising the bundles system in an application which has a lot of
frameworks linked to it. See the release notes for more details.
1.2 Noteworthy changes in version `1.13.0'
==========================================
Several sets of classes have been added for dealing with urls and
predicates. A few minor api changes have occured as well. See the
release notes for more details.
predicates. A few minor api changes have occured as well.
Noteworthy changes in version `1.12.0'
======================================
1.3 Noteworthy changes in version `1.12.0'
==========================================
There have been a number of API changes and several methods have been
depreciated in this release. Although current GNUstep programs that use
@ -28,8 +40,8 @@ can be set to not write to an external file at all, for developers who
wish to use the library as a stand-alone library or in other situations
where using external resources is not desired.
Noteworthy changes in version `1.11.2'
======================================
1.4 Noteworthy changes in version `1.11.2'
==========================================
* Support for GNUstep.conf and relocation of the filesystem is much
improved in this release.
@ -45,8 +57,8 @@ Noteworthy changes in version `1.11.2'
* Some support for keeping user defaults in the Windows registry
implemented.
Noteworthy changes in version `1.11.1'
======================================
1.5 Noteworthy changes in version `1.11.1'
==========================================
* New Cocoa class NSSortDescriptor
@ -57,8 +69,8 @@ Noteworthy changes in version `1.11.1'
* More support for debugging on mingw, including writing logs to
debugger and event viewer.
Noteworthy changes in version `1.11.0'
======================================
1.6 Noteworthy changes in version `1.11.0'
==========================================
This release is binary incompatible with previous releases. The
interface version of the library has changed so that apps, tools and
@ -76,13 +88,13 @@ new version.
* NSRunLoop and related classes use natvie win32 event handling on
Windows machines.
Noteworthy changes in version `1.10.3'
======================================
1.7 Noteworthy changes in version `1.10.3'
==========================================
This version includes a few minor bug fixes.
Noteworthy changes in version `1.10.2'
======================================
1.8 Noteworthy changes in version `1.10.2'
==========================================
This version mostly includes minor fixes and updates.
@ -95,8 +107,8 @@ This version mostly includes minor fixes and updates.
* Use a proper one-to-one abbreviation dictionary for NSTimeZone.
Noteworthy changes in version `1.10.1'
======================================
1.9 Noteworthy changes in version `1.10.1'
==========================================
This version mostly includes minor fixes and updates.
@ -110,8 +122,8 @@ This version mostly includes minor fixes and updates.
* Designated initializers for NSArray, NSDictionary, NSSet, and
NSString have been changed for MacOS X compatibility.
Noteworthy changes in version `1.10.0'
======================================
1.10 Noteworthy changes in version `1.10.0'
===========================================
Note the interface version of the library has changed so that apps,
tools and libraries the use the base library need to be recompiled to
@ -124,8 +136,8 @@ use it.
* Mac OSX XML compatibility fixes.
Noteworthy changes in version `1.9.2'
=====================================
1.11 Noteworthy changes in version `1.9.2'
==========================================
* GSMime parsing ignores extraneous data
@ -142,8 +154,8 @@ Noteworthy changes in version `1.9.2'
* Binary incompatibility: NSUnarchiver, GSIMapTable have new ivars
added
Noteworthy changes in version `1.9.1'
=====================================
1.12 Noteworthy changes in version `1.9.1'
==========================================
* Default string encoding taken from system nl_langinfo if not set
with GNUSTEP_STRING_ENCODING.
@ -153,8 +165,8 @@ Noteworthy changes in version `1.9.1'
* NSPropertyLists class added, also decodes Mac OS X binary propery
lists.
Noteworthy changes in version `1.9.0'
=====================================
1.13 Noteworthy changes in version `1.9.0'
==========================================
* Lazy locking implemented (see GSLock documentation)
@ -170,8 +182,8 @@ Noteworthy changes in version `1.9.0'
* NSString subclass heirarchy reorganized to fix problems with
copying and ownership of data.
Noteworthy changes in version `1.8.0'
=====================================
1.14 Noteworthy changes in version `1.8.0'
==========================================
Read the NEWS file for a complete list of changes since the last stable
version. The major change is that the header files (both in the package
@ -180,15 +192,15 @@ changes in gnustep-make, several components of gnustep-base are located
in different locations. Generally this should not affect the
compilation or running of applications and tools.
Noteworthy changes in version `1.7.4'
=====================================
1.15 Noteworthy changes in version `1.7.4'
==========================================
* Added Korean encoding
* Updated use of ObjCRuntime functions.
Noteworthy changes in version `1.7.3'
=====================================
1.16 Noteworthy changes in version `1.7.3'
==========================================
Note in this version there have been large changes to the location of
header files (both in the package and when installed). It's possible
@ -199,8 +211,8 @@ specific headers may not compile because of this.
* New TraditionalChinese language.
Noteworthy changes in version `1.7.2'
=====================================
1.17 Noteworthy changes in version `1.7.2'
==========================================
* NSUndoManager improvements
@ -210,13 +222,13 @@ Noteworthy changes in version `1.7.2'
* Improvements to handle selectors better over remote connections.
Noteworthy changes in version `1.7.1'
=====================================
1.18 Noteworthy changes in version `1.7.1'
==========================================
Bug fixes.
Noteworthy changes in version `1.7.0'
=====================================
1.19 Noteworthy changes in version `1.7.0'
==========================================
See gnustep-make for comments on the filesystem change. Some components
of gnustep-base are now stored in different directories and in some
@ -232,8 +244,8 @@ changes:
* Added man page for gdomap
Noteworthy changes in version `1.6.0'
=====================================
1.20 Noteworthy changes in version `1.6.0'
==========================================
* More MinGW support
@ -247,8 +259,8 @@ Noteworthy changes in version `1.6.0'
* Any many many bug fixes and minor improvements.
Noteworthy changes in version `1.5.1'
=====================================
1.21 Noteworthy changes in version `1.5.1'
==========================================
* Port NSThread to MingW
@ -266,8 +278,8 @@ Noteworthy changes in version `1.5.1'
* NSTimeZone code rewritten for speed.
Noteworthy changes in version `1.5.0'
=====================================
1.22 Noteworthy changes in version `1.5.0'
==========================================
* New MacOSX methods implemented (NSString, NSArray, NSObject)
@ -275,13 +287,13 @@ Noteworthy changes in version `1.5.0'
* Tcp connections use runloop in NSConnectionReplyMode.
Noteworthy changes in version `1.4.0'
=====================================
1.23 Noteworthy changes in version `1.4.0'
==========================================
* gdomap - security bug fixes.
Noteworthy changes in version `1.3.4'
=====================================
1.24 Noteworthy changes in version `1.3.4'
==========================================
This is a first pre-release version for 1.4.
@ -292,8 +304,8 @@ users are urged to upgrade to this version as soon as possible.
* New combined Unix/Windows version of NSFileHandle
Noteworthy changes in version `1.3.3'
=====================================
1.25 Noteworthy changes in version `1.3.3'
==========================================
Note there are interface and binary changes in this release that
require you to recompile all applications and tools that use
@ -313,8 +325,8 @@ gnustep-base.
* Support for system-wide .GNUsteprc
Noteworthy changes in version `1.3.2'
=====================================
1.26 Noteworthy changes in version `1.3.2'
==========================================
* Corrections for handling Windows file paths, etc
@ -331,8 +343,8 @@ Noteworthy changes in version `1.3.2'
* Unicode and UTF8 handling improvements.
Noteworthy changes in version `1.3.0'
=====================================
1.27 Noteworthy changes in version `1.3.0'
==========================================
* Moved additional classes into subprojects and/or bundles to make it
easier to port these to other Foundation libraries..
@ -347,8 +359,8 @@ Noteworthy changes in version `1.3.0'
* New, partially finished Objective-C/Foundation programming manual.
Noteworthy changes in version `1.1.0'
=====================================
1.28 Noteworthy changes in version `1.1.0'
==========================================
* Removed use of distributed lock to sync defaults file.
@ -369,16 +381,16 @@ Noteworthy changes in version `1.1.0'
* XML property lists
Noteworthy changes in version `1.0.2'
=====================================
1.29 Noteworthy changes in version `1.0.2'
==========================================
Mostly a bug fix release to work with the new gcc 3.0.
* Added support for special gcc 3.0 options (constant string
support).
Noteworthy changes in version `1.0.1'
=====================================
1.30 Noteworthy changes in version `1.0.1'
==========================================
* Many fixes to work better with Darwin (still not there).
@ -393,8 +405,8 @@ Noteworthy changes in version `1.0.1'
* More memory debugging support.
Noteworthy changes in version `1.0.0'
=====================================
1.31 Noteworthy changes in version `1.0.0'
==========================================
* Fix parsing of arguments for new linux kernels.
@ -404,8 +416,8 @@ Noteworthy changes in version `1.0.0'
* Update unicode support and fixes
Noteworthy changes in version `0.9.1'
=====================================
1.32 Noteworthy changes in version `0.9.1'
==========================================
* New MacOSX compatible files for NSCalendarDate, NSTimeZone
@ -417,8 +429,8 @@ Noteworthy changes in version `0.9.1'
* Added some gettext compatible localization macros.
Noteworthy changes in version `0.9.1'
=====================================
1.33 Noteworthy changes in version `0.9.1'
==========================================
* Fixes for building on FreeBSD
@ -428,8 +440,8 @@ Noteworthy changes in version `0.9.1'
* Updated for Makefile package changes.
Noteworthy changes in version `0.9.0'
=====================================
1.34 Noteworthy changes in version `0.9.0'
==========================================
* Workaround when no host IP set.
@ -466,8 +478,8 @@ Noteworthy changes in version `0.9.0'
* Removed obsolete classes.
Noteworthy changes in version `0.6.6'
=====================================
1.35 Noteworthy changes in version `0.6.6'
==========================================
* Lots of new documentation.
@ -483,8 +495,8 @@ Noteworthy changes in version `0.6.6'
* More optimization of classes.
Noteworthy changes in version `0.6.5'
=====================================
1.36 Noteworthy changes in version `0.6.5'
==========================================
* Better debugging information.
@ -497,8 +509,8 @@ Noteworthy changes in version `0.6.5'
* Lots of optimizations and bug fixes.
Noteworthy changes in version `0.6.0'
=====================================
1.37 Noteworthy changes in version `0.6.0'
==========================================
Most of the changes to the Base Library are bug fixes and updates to
include MacOS-X specifications. Although the base library hasn't been
@ -513,8 +525,8 @@ and installations, and is considered to be fairly stable.
* Performance boosts in many classes.
Noteworthy changes in version `0.5.5'
=====================================
1.38 Noteworthy changes in version `0.5.5'
==========================================
Too many changes to mention in detail, but here is a list of a few:
@ -532,15 +544,15 @@ Too many changes to mention in detail, but here is a list of a few:
pasteboards.
Noteworthy changes in version `0.5.1'
=====================================
1.39 Noteworthy changes in version `0.5.1'
==========================================
* Additional runtime functions for interaction with Guile and
ObjC-Guile library.
Noteworthy changes in version `0.5.0'
=====================================
1.40 Noteworthy changes in version `0.5.0'
==========================================
* Improvements to the NSInvocation class, from Masatake Yamato
<masata-y@aist-nara.ac.jp>.
@ -554,8 +566,8 @@ Noteworthy changes in version `0.5.0'
<richard@brainstorm.co.uk>.
Noteworthy changes in version `0.4.0'
=====================================
1.41 Noteworthy changes in version `0.4.0'
==========================================
* New tools for maintaining the defaults database.
@ -589,8 +601,8 @@ Noteworthy changes in version `0.4.0'
* Many, many, many, many bug fixes and new classes.
Noteworthy changes since version `0.1.19'
=========================================
1.42 Noteworthy changes since version `0.1.19'
==============================================
* The library has changed its name from `libobjects' to
`libgnustep-base'. The Apr 17 ChangeLog entry contains a list of
@ -691,8 +703,8 @@ Noteworthy changes since version `0.1.19'
* ...and many bug fixes.
Noteworthy changes since version `0.1.14'
=========================================
1.43 Noteworthy changes since version `0.1.14'
==============================================
* Can be made as a shared library by passing `--enabled-shared' to
`configure'. Thanks to Jan Kybic <kybic@earn.cvut.cz> and Bryan
@ -726,8 +738,8 @@ Noteworthy changes since version `0.1.14'
places.
Noteworthy changes since version `0.1.13'
=========================================
1.44 Noteworthy changes since version `0.1.13'
==============================================
* NSProcessInfo class, thanks to Georg Tuparev.
@ -741,8 +753,8 @@ Noteworthy changes since version `0.1.13'
* Many bug fixes.
Noteworthy changes since version `0.1.12'
=========================================
1.45 Noteworthy changes since version `0.1.12'
==============================================
* Bug fixes: installation; NSArray and NSDictionary copying;
NSArray, NSDictionary, NSData, NSArchiver, NSUnarchiver concrete
@ -750,8 +762,8 @@ Noteworthy changes since version `0.1.12'
ChangeLog for more details.
Noteworthy changes since version `0.1.10'
=========================================
1.46 Noteworthy changes since version `0.1.10'
==============================================
* Now using `src', `config' and `doc' directories to un-clutter the
top-level directory.
@ -768,8 +780,8 @@ Noteworthy changes since version `0.1.10'
* And several bug fixes. See the ChangeLog for details.
Noteworthy changes since version `0.1.9'
========================================
1.47 Noteworthy changes since version `0.1.9'
=============================================
* Renamed "foundation" include file directory to "Foundation", in
accordance with OpenStep.
@ -778,8 +790,8 @@ Noteworthy changes since version `0.1.9'
0.1.9.
Noteworthy changes since version `0.1.8'
========================================
1.48 Noteworthy changes since version `0.1.8'
=============================================
* Many new GNUStep classes: NSEnumerator, NSArrayEnumerator, NSCoder,
NSArchiver, NSUnarchiver, NSData, NSMutableData, NSGCoder,
@ -815,8 +827,8 @@ Noteworthy changes since version `0.1.8'
implementations back in Collection.m.
Noteworthy changes since version `0.1.7'
========================================
1.49 Noteworthy changes since version `0.1.7'
=============================================
* Thanks to Adam Fedor <fedor@boulder.colorado.edu>, classes
NSBundle, NSNumber and NSValue are now operational. He also
@ -837,8 +849,8 @@ Noteworthy changes since version `0.1.7'
deallocation and behavior adding. See the ChangeLog for details.
Noteworthy changes since version `0.1.5'
========================================
1.50 Noteworthy changes since version `0.1.5'
=============================================
* Better string handling. NSString is now fleshed out, and I've
implemented a scheme by which the GNU String object and OpenStep's
@ -865,8 +877,8 @@ Noteworthy changes since version `0.1.5'
are in the ChangeLog.
Noteworthy changes since version `0.1.3'
========================================
1.51 Noteworthy changes since version `0.1.3'
=============================================
This release not well tested at all. We desperately need someone to
write a test suite using dejagnu. Any volunteers?
@ -892,8 +904,8 @@ made on GNUSTEP.
`autorelease', `dealloc' instead of `free'.
Noteworthy changes since version `0.1.0'
========================================
1.52 Noteworthy changes since version `0.1.0'
=============================================
* New category: ObjectRetaining. New classes: AutoreleasePool,
AutoreleaseStack.
@ -902,8 +914,8 @@ Noteworthy changes since version `0.1.0'
README.ULTRIX. Time.m patched for Solaris 2.4. test12.m free fix.
Noteworthy changes in version `0.1.0'
=====================================
1.53 Noteworthy changes in version `0.1.0'
==========================================
* Renamed the library from `libcoll' to `libgnustep-base'. (See the
end of the file `DISCUSSION' for the background on this name
@ -936,8 +948,8 @@ Noteworthy changes in version `0.1.0'
for NeXT-compatible zone functions.
Noteworthy changes in verion `940524'
=====================================
1.54 Noteworthy changes in verion `940524'
==========================================
* A NeXT-compatible NXStringTable object, thanks to Adam Fedor
<adam@bastille.rmnug.org>.
@ -963,8 +975,8 @@ Noteworthy changes in verion `940524'
for better NeXT-compability. And more.
Noteworthy changes in version `931026'
======================================
1.55 Noteworthy changes in version `931026'
===========================================
* Installation using `./configure' and `autoconf'

35
README
View file

@ -1,25 +1,30 @@
Readme
******
1 Readme
********
The GNUstep Base Library is a library of general-purpose, non-graphical
Objective C objects. For example, it includes classes for strings,
object collections, byte streams, typed coders, invocations,
notifications, notification dispatchers, moments in time, network ports,
remote object messaging support (distributed objects), and event loops.
ftp.gnustep.org
It provides functionality that aims to implement the non-graphical
pub/daily-snapshots
The GNUstep Base Library is a library of general-purpose,
non-graphical Objective C objects. For example, it includes classes
for strings, object collections, byte streams, typed coders,
invocations, notifications, notification dispatchers, moments in time,
network ports, remote object messaging support (distributed objects),
and event loops.
It provides functionality that aims to implement the non-graphical
portion of the OpenStep standard (the Foundation library).
Initial reading
===============
1.1 Initial reading
===================
The file `NEWS' has the library's feature history.
The files `INSTALL' or `GNUstep-HOWTO' (from the web site) gives
instructions for installing the library.
License
=======
1.2 License
===========
The GNUstep libraries and library resources are covered under the GNU
Lesser Public License. This means you can use these libraries in any
@ -43,14 +48,14 @@ NSConnection. "Ffcall is under GNU GPL. As a special exception, if used
in GNUstep or in derivate works of GNUstep, the included parts of ffcall
are under GNU LGPL" (Text in quotes provided by the author of ffcall).
How can you help?
=================
1.3 How can you help?
=====================
* Give us feedback! Tell us what you like; tell us what you think
could be better.
Please log bug reports on the GNUstep project page
<http://savannah.gnu.org/bugs/?group=gnustep> or send bug reports
`http://savannah.gnu.org/bugs/?group=gnustep' or send bug reports
to <bug-gnustep@gnu.org>.