Skip to content

Commit

Permalink
Readme update (eclipse-che4z#75)
Browse files Browse the repository at this point in the history
* Update README.md
Getting started done
* Update README.md
features done
* CA - Conditional Assembly
* address comments
* some edits to "macro tracer config"
* ### Macro Tracer Configuration done
* ### External Macro Libraries and COPY Members
* more to last section
more clarifications, rescue example case from previous readme
* renamed HLASM Debug to HLASM Macro tracer
* remove dupe para
* Commenting out "todo" bits
* gifs showing HLASM functionality
* CA Endevor SCM
* naming fix
* move highligting picture
* Using the Macro Tracer section added - REVIEW NEEDED
* Update README.md
final edits to readme
* Update README.md
* Update README.md
adding gifs back
* uncomment new additions
* suggestions
* further suggestions
* readding
Readding the bits removed
* Readme update (eclipse-che4z#72) (eclipse-che4z#76)
* Fix highlighting gif
* New gif uploaded
  • Loading branch information
zeibura authored and slavek-kucera committed Jan 9, 2020
1 parent 2da634d commit 9b88837
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions clients/vscode-hlasmplugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The HLASM Language Support extension parses and analyzes all parts of a HLASM pr
### Highlighting
The HLASM Language Support extension highlights statements with different colors for labels, instructions, operands, remarks and variables. Statements containing instructions that can have operands are highlighted differently to statements that do not expect operands. Code that is skipped by branching AIF, AGO or conditional assembly is not colored.

![](readme_res/highligting.png)
![](readme_res/highlighting.png)

### Autocomplete
Autocomplete is enabled for the instruction field. While typing, a list of instructions starting with the typed characters displays. Selecting an instruction from the list completes it and inserts the default operands. Variables and sequence symbols are also filled with a value from their scope.
Expand All @@ -43,23 +43,26 @@ The macro tracer functionality allows you to track the process of assembling HLA

The macro tracer is not a debugger. It cannot debug running executables, only track the compilation process.

![](readme_res/tracer.gif)
## Configuration

### Macro Tracer Configuration

To configure the macro tracer, **follow these steps**:
### Configuring the Macro Tracer

1. Open your workspace.
2. In the left sidebar, click the bug icon to open the debugging panel.
3. Click the cog icon in the top left of the screen.
A "select environment" prompt displays.
4. Enter **HLASM Macro tracer**.
Your workspace is now configured for macro tracing.
5. Open the file that you want to trace.
6. Return to the debugging panel and press **F5** to start the debugging session.

### External Macro Libraries and COPY Members
### Using the Macro Tracer

To run the macro tracer, open the file that you want to trace. Then press **F5** to open the debugging panel and start the debugging session.

When the tracer stops at a macro or COPY instruction, you can select **step into** to open the macro or COPY file, or **step over** to skip to the next line.

Breakpoints can be set before or during the debugging session.

![](readme_res/tracer.gif)

## External Macro Libraries and COPY Members
The HLASM Language Support extension looks for locally stored members when a macro or COPY instruction is evaluated. The paths of these members are specified in two configuration files in the .hlasmplugin folder of the currently open workspace. Ensure that you configure these files before using macros from separate files or the COPY instruction.

When you open a HLASM file or manually set the HLASM language for a file, you can choose to automatically create these files for the current program.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9b88837

Please sign in to comment.