diff --git a/docs/EN_US/ConfiguringHPCC/ConfiguringHPCC.xml b/docs/EN_US/ConfiguringHPCC/ConfiguringHPCC.xml index 3dff4ff3f4e..79dbecac172 100644 --- a/docs/EN_US/ConfiguringHPCC/ConfiguringHPCC.xml +++ b/docs/EN_US/ConfiguringHPCC/ConfiguringHPCC.xml @@ -239,8 +239,7 @@ Specify whether or not to allow queries to be run - immediately on Roxie. This must be enabled to run the - debugger. (Default is true) + immediately on Roxie. (Default is true) diff --git a/docs/EN_US/HPCCClientTools/CT_Mods/CT_ECL_IDE.xml b/docs/EN_US/HPCCClientTools/CT_Mods/CT_ECL_IDE.xml index d7eac0e8424..a39e2023bb7 100644 --- a/docs/EN_US/HPCCClientTools/CT_Mods/CT_ECL_IDE.xml +++ b/docs/EN_US/HPCCClientTools/CT_Mods/CT_ECL_IDE.xml @@ -1439,13 +1439,6 @@ compiles but does not execute the ECL. Allows the workunit to be published for later execution. - - - Debug - Submits - hThor and Roxie ECL code to the compiler and opens a - debugger window. See ECL - Debugger section for more information. - @@ -3024,13 +3017,6 @@ ENDMACRO; not execute the ECL. This allows the workunit to be published for later execution. - - - Debug submits hThor or - Roxie ECL code to the compiler and opens a debugger window. See - ECL Debugger section for more - information. - The More button displays @@ -3136,10 +3122,6 @@ ENDMACRO; allows you to specify a timeout that will abort the job if exceeded. - The Debug button invokes the - browser which enables you to step through your ECL to monitor - progress and identify problems. - The Archive button is for debugging purposes and archives all ECL (including dependencies) into the workunit for examination without executing the code. @@ -3147,10 +3129,6 @@ ENDMACRO; The Enhanced Syntax Check checkbox allows you to enable enhanced syntax checking. - - The Debug textbox allows you - to supply debug options (with our assistance) to help our developers - resolve issues. @@ -3590,736 +3568,5 @@ ENDMACRO; - - - ECL Debugger - - - Introduction - - The ECL Debugger provides quick and easy access to features - which show you exactly how your ECL query is working. It is integrated - into the ECL IDE, giving immediate access to the debugging process as - you develop your queries. It is a useful development tool helping you - to: - - - - Learn how the ECL Language works. - - - - Develop a query to see how it works. - - - - Verify that your query behaves as you expected. - - - - Identify why your query is not working as you - expected. - - - - Currently the debugger shows debugging information for any query - which is run on an hThor or Roxie cluster. - - - - - - - - - - Note: - - The ability to view debugging information for queries - run against a Thor cluster is part of ongoing planned - development of this tool. - - - - - - - - Global and Active Graphs - - The two graph windows are displayed side by side within the ECL - IDE. - - - - - - The Global Graph shows exactly what Roxie/hThor was asked to - execute by the compiler. It is primarily used for navigating around - the graph and setting breakpoints. - - The Active window shows what is actually being executed. The - graph in the Active window may change its shape during the debugging - process. - - These graphs may show different information. The Global Graph - may not show the parts of the graph that cannot be executed, for - example, IF statements or when using the Graph command. The Active - window may show expanded sections for commands such as Graph or - Library. - - - - Edges and Vertices - - The graphs are displayed as a series of edges and - vertices. - - A vertex is an ECL keyword or activity, for example, SORT or - JOIN. Vertices are represented on the graphs surrounded by a - rectangle. When a vertex is selected and has a definition associated - with it, the ECL that caused it to be created is highlighted in the - Debug Information window. - - An edge is shown on the graphs as a line joining two vertices - and represents the data flowing between them. When an edge is - selected, the last N rows of data are displayed in the Debug - Information window. - - The Properties window shows the details associated with the - currently selected edge or vertex, for example, the definition, id, - label, name, etc. - - - - Breakpoints - - Using the ECL Debugger breakpoint feature, the debugging process - can be paused at any point. - - Global breakpoints stop the debugging process every time the - specified condition is met. Local breakpoints stop the process only - for that specific occurrence. - - The debugging process pauses at the point at which the - breakpoint is set. Breakpoints can only be set on edges. However, - there are a number of ways to use breakpoints: - - - - A simple breakpoint does not contain any specific - conditions. The debugging process pauses on reaching the edge - where the breakpoint was set. - - - - A breakpoint containing conditions and a value, pauses the - debugging process when that condition is met. - - - - A breakpoint set on the ECL code in the Debug Information - window, pauses the debugging process when the first row of data - arrives at the edge of the vertex you selected. - - - - There are four breakpoint modes: - - - - - - - - - - Break - - Pauses the debugging process at the specified - edge. - - - - Skip - - Skips any row that matches the conditions set. - - - - Limit - - Only allows the specified number of rows - through. - - - - Continue - - Temporarily disables a breakpoint that is not currently - needed but that might be required later. - - - - - - Using the many different types of Condition settings available, - means you can customize the debugging process to meet your specific - requirements. For example, you may want to pause the debugging process - when a specific field contains a specific value to make sure your - query is behaving as you expect. - - Using breakpoints helps you to understand how your query works - enabling you to focus on those areas which are not working as you - expected. - - Each breakpoint you set on your graph is shown in the list in - the Breakpoints window showing the settings used to create each one - including, for example, Edge ID, Mode, Condition, etc. - - - - Starting the ECL Debugger - - - - Login to the ECL IDE in the usual way. - - - - Open or create your ECL Query in a Builder window. Make sure - that the Queue and Cluster you have selected point to either an - hThor or a Roxie cluster. - - - - Press the More button located on at the top right of the - Builder window. Press the Debug - Button. - - - - The ECL Debugger workspace displays a graph in the Global - window, but the Active window is empty since the debug process has not - yet begun. - - - - - - - - Debugger Menus - - The Home and View menu options are identical to those on the - main the ECL IDE menu. - - - Basic Menu - - The Basic ribbon bar contains the following - features: - - The Process options - include: - - - - - - - - - - Detach - - Detaches from the current debugging session and - allows the workunit to run to completion. - - - - Abort - - Aborts the current workunit which also causes the - debugging session to abort. - - - - Break - - Pause the execution of the running workunit. - - - - Continue - - Continues the execution of a paused workunit - - - - - - The Graph options - include: - - - - - - - - - - Step - - Continues the debugging process until the next graph - event. This is typically the start of a new active graph or - the end of the current active graph. - - - - Step Start - - Continues the debugging process until a new active - graph is about to start. - - - - Step End - - Continues the debugging process until the current - active graph completes. - - - - - - The Edge options - include: - - - - - - - - - - Step - - Continues the debugging process until a new row of - data is available on any edge in the active graph. - - - - Next - - Continues the debugging process until a new row of - data arrives at the active edge or until the current active - graph completes. - - - - - - The Breakpoint(s) options - include: - - - - - - - - - - Add Global - - Adds a global conditional breakpoint. - - - - Add - - Adds a local conditional breakpoint. - - - - Clear - - Clears all the breakpoints on the selected - edge. - - - - Clear All - - Clears all breakpoints. - - - - - - The Find options - include: - - - - - - - - - - Find - - Locates a vertex with matching text in the graph you - are currently using (Global or Active). - - - - Next - - Locates the next occurrence in the graph you are - currently using. - - - - Previous - - Locates the previous occurrence in the graph you are - currently using. - - - - Goto - - Locates the subgraph/vertex/edge which matches the - specified ID and centers it. - - - - - - The View options - include: - - - - - - - - - - Zoom - - Resizes the graph according to your - selection. - - - - Recenter - Active - - When the graph is paused, clicking on this option - takes you to the active edge on that graph. - - - - Layout - - Performs a new layout on the active graph. This can - be particularly useful when the label have changed. The top - progress bar shows that data is being sent/received from the - server. The bottom progress bar shows when the graph layout - is being calculated. - - - - - - - - Advanced Menu - - The Advanced ribbon bar contains the following - features: - - The Global Filter options - include: - - - - - - - - - - Running - Only - - Only shows items that have started to - execute. - - - - Search Results - Only - - Only shows items that have been found using the - Search Window. - - - - - - The Active Filter options - include: - - - - - - - - - - Running - Only - - Only shows items that have started to - execute. - - - - Search Results - Only - - Only shows items that have been found using the - Search Window. - - - - - - - - - Stepping through a query - - - - At the start of the debugging process, Press Edge/Step. The - graph will continue to the next row of data available at any edge - of the active graph. - - - - Continue pressing Edge/Step watching the debugger go through - each row of data until it reaches the end of that graph. - - - - Press Edge/Step again to see a new graph start. - - - - Notice that contents of the Debug Information window change - as the debugging process passes over each edge. - - - - Click on an edge or vertex and view the related details in - the Properties window. - - - - Once the debugging process has completed, the results of - your query are displayed. - - - - Navigating the graph using ECL - - - - Click on Graph/Step Start. The next active graph is - loaded. - - - - In the Debug Information window, select the Builder - tab. - - - - Scroll down to the line of ECL which defines what you want - to locate. - - - - Left click on the red circle and select the number of the - vertex to be located. - - - - Selecting the edge of the selected vertex, right click and - use the Continue to.. option. The debugging process will continue - until the first row of data arrives at the edge you - selected. - - - - Click on Edge/Next. The debugging process continues until a - new row arrives at the active edge. - - - - Setting global breakpoints - - - - Click on Breakpoint(s)/Add Global. - - - - Select the Mode required. - - - - Set the Conditions to be applied. - - - - Click the OK button. - - - - - - - - - - Setting local breakpoints - - - - Select the edge on the graph where you want the breakpoint - to be set. - - - - Click on Breakpoint(s)/ Add, or right click and select Add - Breakpoint. - - - - Select the Mode required. - - - - Set the conditions to be applied. - - - - Click the OK button. The breakpoint is shown on the graph as - a red dot. - - - - - - - - Note: Simple breakpoints that - do not require any conditions to be set, are quickly added by - selecting an edge and using the right-click option Set Breakpoint. - Breakpoints set in this way use the default settings which are the - Mode setting Break and the Condition Always. - - - - Setting a breakpoint on a line of ECL - - - - Using the Debug Information window, click on the Builder - tab. - - - - Scroll the any line which begins with a red circle. - - - - Left click on the red circle and select Set Breakpoint. Two - breakpoints are added to the graph. - - - - Removing breakpoints - - To remove a single breakpoint: - - - - Highlight the edge where the breakpoint is shown and click - on Breakpoints/Clear, or right-click and select Clear - Breakpoint(s). - - - - Single breakpoints can also be removed by right-clicking on - the breakpoint listed in the Breakpoints window and selecting - delete. - - - - To remove all breakpoints on the graph: - - - - Click on Breakpoint(s)/Clear All. - - - - Using the search window - - - - Enter your search criteria in Field and Value. - - - - Click on the Search button. Matches for your search are - located and the Edge IDs are displayed. - - - - Click on the Edge IDs to locate each match on the - graph. - - - - View the Debug Information window to see the data content - which shows your search criteria highlighted. - - - - Note: Only the last 10 rows of - data that flowed through any given edge are searched. - - diff --git a/docs/EN_US/HPCCClientTools/CT_Mods/CT_Overview.xml b/docs/EN_US/HPCCClientTools/CT_Mods/CT_Overview.xml index d2707297ab2..f0014014816 100644 --- a/docs/EN_US/HPCCClientTools/CT_Mods/CT_Overview.xml +++ b/docs/EN_US/HPCCClientTools/CT_Mods/CT_Overview.xml @@ -21,13 +21,6 @@ create, edit, and execute ECL code. - - ECL Debugger - - A development tool integrated into the ECL IDE, which is used - to debug queries as they are developed. - - ECLPlus diff --git a/docs/EN_US/HPCCSystemAdmin/SA-Mods/SysAdminConfigMod.xml b/docs/EN_US/HPCCSystemAdmin/SA-Mods/SysAdminConfigMod.xml index 6385e849368..04dbf27da50 100644 --- a/docs/EN_US/HPCCSystemAdmin/SA-Mods/SysAdminConfigMod.xml +++ b/docs/EN_US/HPCCSystemAdmin/SA-Mods/SysAdminConfigMod.xml @@ -200,8 +200,7 @@ Specify whether or not to allow queries to be run - immediately on Roxie. This must be enabled to run the - debugger. (Default is true) + immediately on Roxie. (Default is true) @@ -272,10 +271,9 @@ If it is running stop the HPCC system (on every node), using a command such as this: - - + @@ -292,7 +290,8 @@ - + + @@ -300,15 +299,17 @@ - + + + Be sure HPCC is stopped before attempting to copy the environment.xml file. - + + diff --git a/docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml b/docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml index 291653bfc1f..5ab32bc85e9 100644 --- a/docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml +++ b/docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml @@ -947,8 +947,7 @@ Specify whether or not to allow queries to be run - immediately on Roxie. This must be enabled to run the - debugger. (Default is true) + immediately on Roxie. (Default is true) diff --git a/docs/EN_US/images/CT57.png b/docs/EN_US/images/CT57.png deleted file mode 100644 index 5e38f940c09..00000000000 Binary files a/docs/EN_US/images/CT57.png and /dev/null differ diff --git a/docs/EN_US/images/CT58.png b/docs/EN_US/images/CT58.png deleted file mode 100644 index c0606df019a..00000000000 Binary files a/docs/EN_US/images/CT58.png and /dev/null differ diff --git a/docs/EN_US/images/CT59.png b/docs/EN_US/images/CT59.png deleted file mode 100644 index fd14f7fe4f2..00000000000 Binary files a/docs/EN_US/images/CT59.png and /dev/null differ diff --git a/docs/EN_US/images/CT60.png b/docs/EN_US/images/CT60.png deleted file mode 100644 index 2c0f56067e6..00000000000 Binary files a/docs/EN_US/images/CT60.png and /dev/null differ diff --git a/docs/EN_US/images/IDE03.jpg b/docs/EN_US/images/IDE03.jpg index 34faa3e1790..184b3abf89f 100644 Binary files a/docs/EN_US/images/IDE03.jpg and b/docs/EN_US/images/IDE03.jpg differ