[YARN-6554] ResourceManagerRest.md should document <CPS> and "{{", "}}" meanings

• Type: Bug
• Status: Open
• Priority: Trivial
• Resolution: Unresolved
• Component/s: site
• Assignee: Unassigned
• Reporter: Grant Sohn
• Created: 03/May/17 20:44
• Updated: 03/May/17 20:44

Description

The docs should mention the meaning of <CPS>, "" and "". These are explained fully in the code.

063      /**
064       * This constant is used to construct class path and it will be replaced with
065       * real class path separator(':' for Linux and ';' for Windows) by
066       * NodeManager on container launch. User has to use this constant to construct
067       * class path if user wants cross-platform practice i.e. submit an application
068       * from a Windows client to a Linux/Unix server or vice versa.
069       */
070      @Public
071      @Unstable
072      public static final String CLASS_PATH_SEPARATOR= "<CPS>";
073    
074      /**
075       * The following two constants are used to expand parameter and it will be
076       * replaced with real parameter expansion marker ('%' for Windows and '$' for
077       * Linux) by NodeManager on container launch. For example: {{VAR}} will be
078       * replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
079       * constant to construct class path if user wants cross-platform practice i.e.
080       * submit an application from a Windows client to a Linux/Unix server or vice
081       * versa.
082       */
083      @Public
084      @Unstable
085      public static final String PARAMETER_EXPANSION_LEFT="{{";
086    
087      /**
088       * User has to use this constant to construct class path if user wants
089       * cross-platform practice i.e. submit an application from a Windows client to
090       * a Linux/Unix server or vice versa.
091       */
092      @Public
093      @Unstable
094      public static final String PARAMETER_EXPANSION_RIGHT="}}";
095