Add GNUstepConfig() to external header

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@22143 72102866-910b-0410-8b05-ffd578937521

Documentation/Base.gsdoc

@@ -488,6 +488,11 @@ notice and this notice are preserved.
 	    The configuration file is not actually required to exist.
 	    If it does not exist, then default values will be used
 	    for the standard path locations.<br />
+	    For specialist applications, program source code is able to
+	    override/replace the config file using the
+	    <ref type="function" id="GNUstepConfig">GNUstepConfig</ref>()
+	    function, but most applications should avoid this and honor
+	    the standard configuration mechanism.<br />
 	    System paths are defined by the following:
 	  </p>
 	    <deflist>

Headers/Foundation/NSPathUtilities.h

@@ -29,6 +29,19 @@
 #include <Foundation/NSString.h>
 
 #ifndef	NO_GNUSTEP
+/**
+ * Function to return a mutable copy of the GNUstep configuration
+ * file contents.<br />
+ * If newConfig is not nil, it is used to set a new system wide
+ * configuration.<br />
+ * This function is provided to allow a program to override the
+ * configuration information which tells GNUstep applications where
+ * all paths to resources/libraries etc in the system are located.<br />
+ * Keys and values in the newConfig dictionary must match those normally
+ * expected in the configuration file (GNUstep.conf).
+ */
+NSMutableDictionary* GNUstepConfig(NSDictionary *newConfig);
+
 /**
  * This extension permits a change of username from that specified in the
  * LOGNAME environment variable.  Using it will almost certainly cause

Source/NSPathUtilities.m

@@ -378,13 +378,6 @@ static void ExtractValuesFromConfig(NSDictionary *config)
     }
 }
 
-/*
- * Function to return a mutable copy of the configuration,
- * either the system wide config, or (if a userName was provided)
- * the config for a specific user.
- * If newConfig is not nil, it is used to set a new system wide
- * configuration.
- */
 NSMutableDictionary*
 GNUstepConfig(NSDictionary *newConfig)
 {