Bug 461728 - [Mac] Allow users to specify values in eclipse.ini outside

of the installation

Update documentation with changed behavior on Mac.

Change-Id: I8b5d64c548f85d1db549fb6d9c8519ad89822177
Signed-off-by: Arun Thondapu <arunkumar.thondapu@in.ibm.com>

2 files changed, 8 insertions, 5 deletions

diff --git a/features/org.eclipse.equinox.executable.feature/library/eclipse.c b/features/org.eclipse.equinox.executable.feature/library/eclipse.c
index 25d6757f0..444c89b88 100644
--- a/features/org.eclipse.equinox.executable.feature/library/eclipse.c
+++ b/features/org.eclipse.equinox.executable.feature/library/eclipse.c
@@ -122,7 +122,10 @@
  *   The launcher gets arguments from the command line and/or from a configuration file.
  * The configuration file must have the same name and location as the launcher executable
  * and the extension .ini. For example, the eclipse.ini configuration file must be
- * in the same folder as the eclipse.exe or eclipse executable.
+ * in the same folder as the eclipse.exe or eclipse executable (except in the case of
+ * Mac OS X where the eclipse.ini can be read from a Mac specific configuration folder
+ * recommended by the OS, see bugs 461725 and 461728 for more details).
+ *
  *   The format of the ini file matches that of the command line arguments - one
  * argument per line.
  *   In general, the settings of the config file are expected to be overriden by the
@@ -285,7 +288,7 @@ static _TCHAR*  timeoutString = NULL;			/* timeout value for opening a file */
 static _TCHAR*  defaultAction = NULL;			/* default action for non '-' command line arguments */ 
 static _TCHAR*  iniFile       = NULL;			/* the launcher.ini file set if  --launcher.ini was specified */
 static _TCHAR*  gtkVersionString = NULL;        /* GTK+ version specified by --launcher.GTK_version */
-static _TCHAR*  protectMode   = NULL;			/* Process -protectMode to trigger the reading of the eclipse.ini in the configuration (at this point mac specific) */
+static _TCHAR*  protectMode   = NULL;			/* Process protectMode specified via -protect, to trigger the reading of eclipse.ini in the configuration (Mac specific currently) */
 
 /* variables for ee options */
 static _TCHAR* eeExecutable = NULL;
diff --git a/features/org.eclipse.equinox.executable.feature/library/eclipseMain.c b/features/org.eclipse.equinox.executable.feature/library/eclipseMain.c
index a2d7478fe..1b68af1cb 100644
--- a/features/org.eclipse.equinox.executable.feature/library/eclipseMain.c
+++ b/features/org.eclipse.equinox.executable.feature/library/eclipseMain.c
@@ -46,7 +46,7 @@ administrative privileges.");
 #define LIBRARY		  _T_ECLIPSE("--launcher.library")
 #define SUPRESSERRORS _T_ECLIPSE("--launcher.suppressErrors")
 #define INI			  _T_ECLIPSE("--launcher.ini")
-#define PROTECT	      _T_ECLIPSE("-protect")
+#define PROTECT	      _T_ECLIPSE("-protect")	/* This argument is also handled in eclipse.c for Mac specific processing */
 #define ROOT		  _T_ECLIPSE("root")		/* the only level of protection we care now */
 
 /* this typedef must match the run method in eclipse.c */
@@ -54,11 +54,11 @@ typedef int (*RunMethod)(int argc, _TCHAR* argv[], _TCHAR* vmArgs[]);
 typedef void (*SetInitialArgs)(int argc, _TCHAR*argv[], _TCHAR* library);
 
 static _TCHAR*  name          = NULL;			/* program name */
-static _TCHAR** userVMarg     = NULL;     		/* user specific args for the Java VM  */
+static _TCHAR** userVMarg     = NULL;     		/* user specific args for the Java VM */
 static _TCHAR*  programDir	  = NULL;			/* directory where program resides */
 static _TCHAR*  officialName  = NULL;
 static int      suppressErrors = 0;				/* supress error dialogs */
-static int      protectRoot      = 0;				/* check if launcher was run as root. This argument is also handled in eclipse.c */
+static int      protectRoot      = 0;				/* check if launcher was run as root, currently works only on Linux/UNIX platforms */
 
 static int 	 	createUserArgs(int configArgc, _TCHAR **configArgv, int *argc, _TCHAR ***argv);
 static void  	parseArgs( int* argc, _TCHAR* argv[], int handleVMArgs );