From 59f79645d2f0b4ccb311a077fb96182de003b5ab Mon Sep 17 00:00:00 2001 From: Andy McFadden Date: Sun, 21 Oct 2018 16:54:44 -0700 Subject: [PATCH] Update docs for new assembler configuration scheme --- SourceGen/RuntimeData/Help/settings.html | 66 ++++++++++++++---------- 1 file changed, 39 insertions(+), 27 deletions(-) diff --git a/SourceGen/RuntimeData/Help/settings.html b/SourceGen/RuntimeData/Help/settings.html index 31fd099..701ddb8 100644 --- a/SourceGen/RuntimeData/Help/settings.html +++ b/SourceGen/RuntimeData/Help/settings.html @@ -41,7 +41,7 @@ out to the main application until you hit Apply or OK.

Code View

-

These settings change the way the code looks.

+

These settings change the way the code looks on screen.

Click the Column Visibility buttons to hide columns. Click them again to restore the column to a default width. A "hidden" column just @@ -68,28 +68,21 @@ opcode, operand, and comment), like assembly source code does. The

Asm Config

-

These settings configure cross-assemblers and modify the output in -various ways.

-

For cc65, locate bin/cl65.exe. Note you need a full -installation of cc65, with configuration files and libraries, not just -the cl65 binary.

-

For Merlin 32, locate Merlin32.exe. The executable -is stand-alone.

- -

If you enable "identify assembler in output", a comment will be -added to the top of the generated assembly output that identifies the -target assembler and version. This can be very helpful if the source -file is sent to other people, since it may not otherwise be obvious from -the source file what the intended target assembler is.

- -

"Disable label localization" turns off the -label localizer.

- -

If "put long labels on separate line" is checked, labels that are -longer than the label column are placed on their own line. This looks -a bit nicer because otherwise the opcode gets pushed out of alignment. -(Some assemblers get bent out of shape if you split an equate -directive, so those might stay on one line.)

+

These settings configure cross-assemblers and modify assembly source +generation in various ways.

+

To configure an assembler, select it in the pop-up menu. The fields +will initially contain assembler-specific default values. All of +the values in the Assembler Configuration box may be configured +differently for each assembler.

+

The "executable" box holds the full path to the cross-assembler +executable. For cc65 this is bin/cl65.exe, for Merlin32 +you need Merlin32.exe. (On non-Windows platforms, you +won't need the ".exe".) For cc65 you need a full installation, with +the configuration files and libraries, not just the cl65 binary itself.

+

The "column widths" section allows you to specify the width of the +label, opcode, operand, and comment fields. If the width is less than 1, +or isn't a valid number, 1 will be used. (Note: the comment width isn't +used at this time.)

When "show cycle counts" is checked, every instruction line will have an end-of-line comment that indicates the number of cycles required for @@ -102,6 +95,21 @@ certain status flags is known, e.g. 65C02 instructions that take longer in decimal mode won't be shown as variable if the analyzer can determine that D=0 or D=1.

+

If "put long labels on separate line" is checked, labels that are +longer than the label column are placed on their own line. This looks +a bit nicer because otherwise the opcode gets pushed out of alignment. +(Some assemblers get bent out of shape if you split an equate +directive, so those might stay on one line.)

+ +

If you enable "identify assembler in output", a comment will be +added to the top of the generated assembly output that identifies the +target assembler and version. This can be very helpful if the source +file is sent to other people, since it may not otherwise be obvious from +the source file what the intended target assembler is.

+ +

"Disable label localization" turns off the +label localizer.

+

Display Format

@@ -119,19 +127,23 @@ operators ('<', '>', '^') act like shift operators, yielding 16-bit values when wide registers are enabled on the 65816.

The "quick set" buttons configure the fields on this tab to match -the conventions of the specified assembler.

+the conventions of the specified assembler. Select your preferred assembler +with the combox box, then click "set" to set the fields.

Pseudo-Op

-

These options change the way the code list looks on screen. They -do not affect generated code.

+

These options change the way the code list looks on screen. Assembler +directives and data pseudo-opcodes will use these values. This does +not affect generated source code, which always matches the conventions +of the target assembler.

Enter the string you want to use for the various data formats. If a field is left blank, a default value is used.

The "quick set" buttons configure the fields on this tab to match -the conventions of the specified assembler.

+the conventions of the specified assembler. Select your preferred assembler +with the combox box, then click "set" to set the fields.

Project Properties