From 9aa8b5c9a7015ff032e8e7abe1b7ab40aa3529bd Mon Sep 17 00:00:00 2001 From: Andy McFadden Date: Sat, 6 Jul 2019 10:58:24 -0700 Subject: [PATCH] Minor documentation updates Also, placate consistency hobgoblins. --- SourceGen/RuntimeData/Help/mainwin.html | 6 ++-- SourceGen/RuntimeData/Help/settings.html | 42 +++++++++++----------- SourceGenWPF/WpfGui/DataFileLoadIssue.xaml | 4 +-- SourceGenWPF/WpfGui/ProjectLoadIssues.xaml | 4 +-- SourceGenWPF/WpfGui/WorkProgress.xaml | 2 +- 5 files changed, 31 insertions(+), 27 deletions(-) diff --git a/SourceGen/RuntimeData/Help/mainwin.html b/SourceGen/RuntimeData/Help/mainwin.html index 7006bed..d11661a 100644 --- a/SourceGen/RuntimeData/Help/mainwin.html +++ b/SourceGen/RuntimeData/Help/mainwin.html @@ -68,14 +68,16 @@ most-recently-opened projects will be available.

The main project window is divided into five areas:

  1. Center: the code list. If no project is open, this will instead - have clickable links to open a new or existing project.
    2. + have buttons to open a new or existing project.
  2. Top left: cross-reference list.
  3. Bottom left: notes list.
  4. Top right: symbols list.
  5. Bottom right: info on selected line.
-

Most of the action takes place in the center code list.

+

Most actions are performed in the center code list. All of the +sub-windows can be resized. The window sizes and column widths are +saved in the application settings file.

Code List

diff --git a/SourceGen/RuntimeData/Help/settings.html b/SourceGen/RuntimeData/Help/settings.html index 6ca979d..ffd9c0e 100644 --- a/SourceGen/RuntimeData/Help/settings.html +++ b/SourceGen/RuntimeData/Help/settings.html @@ -15,9 +15,12 @@

Settings Overview

-

There are two classes of settings: application settings, and +

There are two kinds of settings: application settings, and project properties.

+ +

Application Settings

+

Application settings are stored in a file called "SourceGen-settings" in the SourceGen installation directory. If the file is missing or corrupted, some default settings will be used. These settings are local @@ -26,15 +29,6 @@ you prefer hexadecimal values to be shown in upper case. None of them affect the way the project analyzes code and data, though they may affect the way generated assembly sources look.

-

Project properties are stored in each individual .dis65 project file. -They specify which CPU to use, which extension scripts to load, and a -variety of other things that directly impact how SourceGen processes -the project. Because of the potential impact, all changes to -the project properties are made through the undo/redo buffer.

- - -

Application Settings

-

The settings editor is divided into four tabs. Changes aren't pushed out to the main application until you hit Apply or OK.

@@ -44,14 +38,14 @@ out to the main application until you hit Apply or OK.

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 -has a width of zero, so with careful mouse positioning you can show and -hide columns from the code list. The buttons may be more convenient -though.

+again to restore the column to a width appropriate for the current font. +A "hidden" column just has a width of zero, so with careful mouse +positioning you can show and hide columns from the code list. The buttons +may be more convenient though.

You can select a different font for the code list. Make it as large or small as you want. Mono-space fonts like Courier or Consolas are -recommended.

+recommended (and will be the only ones shown).

You can choose to display different parts of the display in upper or lower case, using the "all lower" and "all upper" buttons as a quick way @@ -111,9 +105,11 @@ 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 +target assembler and version. It also shows the command-line options +passed to the assembler. 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.

+the source file what the intended target assembler is, or what options +are required to process the file correctly.

"Disable label localization" turns off the label localizer.

@@ -156,9 +152,15 @@ with the combox box, then click "set" to set the fields.

Project Properties

+

Project properties are stored in the .dis65 project file. +They specify which CPU to use, which extension scripts to load, and a +variety of other things that directly impact how SourceGen processes +the project. Because of the potential impact, all changes to +the project properties are made through the undo/redo buffer.

+

The properties editor is divided into four tabs. Changes aren't pushed out to the main application until you close the dialog. Clicking Apply -will "latch" the current changes, ensuring that they're applied even if +will capture the current changes, ensuring that they're applied even if you later hit Cancel, but the changes are not applied immediately.

All changes are subject to undo/redo.

@@ -185,11 +187,11 @@ opcodes are recognized on the 6502 and 65C02. These instructions are not part of the chip specification, but most of them have consistent behavior and can be used. If the box is not checked, the instructions are treated as invalid and cause the code analyzer to assume that it -has run into a data area.

+has run into a data area. This option has no effect on the 65816.

The entry flags determine the initial value for the processor status flag register. Code that is unreachable internally (requiring a code -entry point hint) will use this value. This is chiefly of use for +entry point hint) will use this value. This is chiefly of value for 65816 code, where the initial value of the M/X/E flags is significant.

If "analyze uncategorized data" is checked, SourceGen will attempt to diff --git a/SourceGenWPF/WpfGui/DataFileLoadIssue.xaml b/SourceGenWPF/WpfGui/DataFileLoadIssue.xaml index 8183b43..25c36c7 100644 --- a/SourceGenWPF/WpfGui/DataFileLoadIssue.xaml +++ b/SourceGenWPF/WpfGui/DataFileLoadIssue.xaml @@ -32,8 +32,8 @@ limitations under the License. -