update upgrading to 11.0

rajivushah · May 3, 2016 · dd9c423 · dd9c423
1 parent 3ed91af
commit dd9c423
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 17 deletions.
diff --git a/site/content/release_notes/110upgrading.markdown b/site/content/release_notes/110upgrading.markdown
@@ -8,3 +8,14 @@ weight: 800
 
 This page contains information about changes in this release which can affect upgrading from previous versions.
 
+
+#### Environment Variables
+
+In previous versions environment variable names were inconsistent, which occasionally led to confusion. Starting with XAP 11.0, all XAP related environment variables have been renamed to have a `XAP_` prefix, so they're easier to identify.  
+
+
+{{%refer%}}
+For more information please visit [Common Environment Variables](/xap110/common-environment-variables.html)
+{{%/refer%}}
+
+
diff --git a/site/content/xap110/common-environment-variables.markdown b/site/content/xap110/common-environment-variables.markdown
@@ -6,32 +6,38 @@ parent: installation-java-overview.html
 weight: 200
 ---
 
-The XAP environment configuration is maintained by a configuration script file called `setenv`, located in the `XAP_HOME/bin` directory. It is recommended to use the `setenv` utility to derive the commonly used GigaSpaces libraries and setup environment. To use this utility, you simply need to call it from your script file.
+The XAP environment configuration is maintained by a configuration script file called `setenv`, located in the `XAP_HOME/bin` directory. It is recommended to use the `setenv` utility to derive the commonly used XAP libraries and setup environment. 
+To use this utility, you simply need to call it from within your script file.
 
 The following list describes commonly used variables which are defined in this script:
 
 |Name|Description|Default Value|
 |:---|:----------|:------------|
-|  JAVA_HOME  |The directory in which Java is installed||
-|  XAP_HOME  |The GigaSpaces XAP home directory| Automatically set via the folder structure |
-|  XAP_LOOKUP_GROUPS  |Lookup Service groups used for multicast discovery| xap-11.0.0 |
-|  XAP_LOOKUP_LOCATORS  | Lookup Service Locators used for unicast discovery||
-|  XAP_NIC_ADDRESS  | The network interface card which will be used by XAP | Automatically set to the host name |
-|  XAP_SECURITY_POLICY  | The default policy file.|XAP_HOME/policy/policy.all |
-|  XAP_LOGS_CONFIG_FILE | The location of XAP logging configuration | XAP_HOME/config/gs_logging.properties |
-|  XAP_GSC_OPTIONS  | Java options for the Grid Service Container (GSC) ||
-|  XAP_GSM_OPTIONS  | Java options for the Grid Service Manager (GSM) ||
-|  XAP_GSA_OPTIONS  | Java options for the Grid Service Agent (GSA) ||
-|  XAP_LUS_OPTIONS  | Java options for the Lookup Service (LUS) ||
-|  XAP_ESM_OPTIONS  | Java options for the Elastic Service Manager (ESM) ||
+|  JAVA_HOME            |The directory in which Java is installed              ||
+|  XAP_HOME             |The GigaSpaces XAP home directory                     | Automatically set via the folder structure |
+|  XAP_LOOKUP_GROUPS    |Lookup Service groups used for multicast discovery    | {{%version "default-lookup-group"%}} |
+|  XAP_LOOKUP_LOCATORS  | Lookup Service Locators used for unicast discovery   ||
+|  XAP_NIC_ADDRESS      | The network interface card which will be used by XAP | Automatically set to the host name |
+|  XAP_SECURITY_POLICY  | The default policy file.|XAP_HOME/policy/policy.all  |
+|  XAP_LOGS_CONFIG_FILE | The location of XAP logging configuration            | XAP_HOME/config/gs_logging.properties |
+|  XAP_GSC_OPTIONS      | Java options for the Grid Service Container (GSC)    ||
+|  XAP_GSM_OPTIONS      | Java options for the Grid Service Manager (GSM)      ||
+|  XAP_GSA_OPTIONS      | Java options for the Grid Service Agent (GSA)        ||
+|  XAP_LUS_OPTIONS      | Java options for the Lookup Service (LUS)            ||
+|  XAP_ESM_OPTIONS      | Java options for the Elastic Service Manager (ESM)   ||
 
 # Overriding Default Values
 
-During initial development and usage of XAP there's usually no need to change any of the default values, but at some point you'll probably want to change some of them (e.g. the Grid Service Container heap size). It is highly recommended not to do those changes within the original `setenv` scripts, as it complicates upgrading XAP later on. Instead, XAP provides an additional empty script called `setenv-overrides`, which is automatically called by `setenv`, and is intended for users to specify their overrides in a safe manner.
+During initial development and usage of XAP there's usually no need to change any of the default values, but at some point you'll probably want to change some of them (e.g. the Grid Service Container heap size). 
+
+
+{{%note%}}
+It is highly recommended not to make those changes in the original `setenv` script, as it complicates upgrading XAP later on. Instead, XAP provides an additional empty script called `setenv-overrides`, which is automatically called by `setenv`, and is intended for users to specify their overrides in a safe manner.
+{{%/note%}}
 
 # Upgrading From Previous Versions
 
-In previous versions environment variables names were inconsistent, which occesionally led to confusion. Starting XAP 11.0, we've renamed all XAP related environment variables to have a `XAP_` prefix, so they're easier to identify. The following table maps the pre-11.0 names to the new names:
+In previous versions, environment variable names were inconsistent, which occasionally led to confusion. Starting with XAP 11.0, all XAP related environment variables have been renamed to have a `XAP_` prefix, so they're easier to identify. The following table maps the pre-11.0 names to the new names:
 
 |Name before 11.0|Name in 11.0|
 |:---|:----------|
@@ -48,7 +54,7 @@ In previous versions environment variables names were inconsistent, which occesi
 |  ESM_JAVA_OPTIONS  |  XAP_ESM_OPTIONS  |
 
 {{%tip%}}
- If you'd rather postpone or avoid changing your scripts to the new names, you can use the new `setenv-overrides` script to map the relevant values. For example, suppose in the past you've needed to override the default lookup groups and the GSC options. If you've followed the best practices, you probably created a custom script to set those environment variables before calling the original script, something like:
+ If you'd rather postpone or avoid changing your scripts to the new names, you can use the new `setenv-overrides` script to map the corresponding values. For example, suppose in the past you've needed to override the default lookup groups and the GSC options. If you've followed the best practices, you probably created a custom script to set those environment variables before calling the original script, something like:
 {{%/tip%}}
 
 
@@ -69,7 +75,7 @@ call gs-agent.bat
 {{%/tab%}}
 {{%/tabs%}}
 
-The `gs-agent` script calls the `setenv` script to setup the environment, which in turn calls the `setenv-overrides` script mentioned above to allow users override the default values. You can modify `setenv-overrides` to propagate the old variables to the new ones, for example:
+The `gs-agent` script calls the `setenv` script to setup the environment, which in turn calls the `setenv-overrides` script mentioned above to allow users to override the default values. You can modify `setenv-overrides` to propagate the old variables to the new ones, for example:
 
 {{%tabs%}}
 {{%tab " setenv-overrides.sh (Unix)"%}}