gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-23 00:41:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Expand documentation of config functions.

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@22534 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2006-02-22 07:39:34 +00:00
parent 91a7ea938e
commit 276ca33bac
2 changed files with 28 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
ChangeLog
View file

@ -2,6 +2,7 @@
* Source/Additions/GSXML.m: Fix parsing error .. was not recognising
base64 elements.
* Headers/Foundation/NSPathUtilitites.h: Expand config documentation
2006-02-21 Richard Frith-Macdonald <rfm@gnu.org>

31
Headers/Foundation/NSPathUtilities.h
View file

@ -50,22 +50,45 @@ GSSetUserName(NSString *aName);
* If the newConfig argument is non-nil it is used to set the config
* overriding any other version. You should not change the config
* after the user defaults system has been initialised as the new
* config will not be picked up by the defaults system.
* config will not be picked up by the defaults system.<br />
* <br />
* A typical sequence of operation might be to<br />
* Call the function with a nil argument to obtain the configuration
* information currently in use (usually obtained from the main GNUstep
* configuration file).<br />
* Modify the dictionary contents.<br />
* Call the function again passing back in the modified config.<br />
* <br />
* If you call this function with a non-nil argument before the system
* configuration file has been read, you will prevent the file from
* being read. However, you must take care doing this that creation
* of the config dictionary you are going to pass in to the function
* does not have any side-effects which would cause the config file
* to be read earlier.<br />
* If you want to prevent the user specific config file from being
* read, you must set the GNUSTEP_USER_CONFIG_FILE value in the
* dictionary to be an empty string.
*/
GS_EXPORT NSMutableDictionary*
GNUstepConfig(NSDictionary *newConfig);
/**
* Returns the location of the defaults database for the specified user.
* This uses the same information you get from GNUstepConfig() and
* GNUstepUserConfig() and builds the path to the defaults database
* fromm it.
*/
GS_EXPORT NSString*
GSDefaultsRootForUser(NSString *username);
/**
* The config dictiuonary passed to this function should be a
* system-wiude config as provided by GNUstepConfig() ... and
* The config dictionary passed to this function should be a
* system-wide config as provided by GNUstepConfig() ... and
* this function merges in user specific configuration file
* information if such a file exists and is owned by the user.
* information if such a file exists and is owned by the user.<br />
* NB. If the GNUSTEP_USER_CONFIG_FILE value in the system-wide
* config is an empty string, no user-specifc config will be
* read.
*/
GS_EXPORT void
GNUstepUserConfig(NSMutableDictionary *config, NSString *userName);