mirror of
https://github.com/fadden/6502bench.git
synced 2024-08-10 08:28:58 +00:00
Minor documentation updates
Also, placate consistency hobgoblins.
This commit is contained in:
parent
8d78ce028a
commit
9aa8b5c9a7
@ -68,14 +68,16 @@ most-recently-opened projects will be available.</p>
|
|||||||
<p>The main project window is divided into five areas:</p>
|
<p>The main project window is divided into five areas:</p>
|
||||||
<ol>
|
<ol>
|
||||||
<li>Center: the code list. If no project is open, this will instead
|
<li>Center: the code list. If no project is open, this will instead
|
||||||
have clickable links to open a new or existing project.</li>
|
have buttons to open a new or existing project.</li>
|
||||||
<li>Top left: cross-reference list.</li>
|
<li>Top left: cross-reference list.</li>
|
||||||
<li>Bottom left: notes list.</li>
|
<li>Bottom left: notes list.</li>
|
||||||
<li>Top right: symbols list.</li>
|
<li>Top right: symbols list.</li>
|
||||||
<li>Bottom right: info on selected line.</li>
|
<li>Bottom right: info on selected line.</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<p>Most of the action takes place in the center code list.</p>
|
<p>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.</p>
|
||||||
|
|
||||||
|
|
||||||
<h3><a name="code-list">Code List</a></h3>
|
<h3><a name="code-list">Code List</a></h3>
|
||||||
|
@ -15,9 +15,12 @@
|
|||||||
|
|
||||||
<h2><a name="overview">Settings Overview</a></h2>
|
<h2><a name="overview">Settings Overview</a></h2>
|
||||||
|
|
||||||
<p>There are two classes of settings: application settings, and
|
<p>There are two kinds of settings: application settings, and
|
||||||
project properties.</p>
|
project properties.</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a name="app-settings">Application Settings</a></h2>
|
||||||
|
|
||||||
<p>Application settings are stored in a file called "SourceGen-settings"
|
<p>Application settings are stored in a file called "SourceGen-settings"
|
||||||
in the SourceGen installation directory. If the file is missing or
|
in the SourceGen installation directory. If the file is missing or
|
||||||
corrupted, some default settings will be used. These settings are local
|
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
|
affect the way the project analyzes code and data, though they may affect
|
||||||
the way generated assembly sources look.</p>
|
the way generated assembly sources look.</p>
|
||||||
|
|
||||||
<p>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.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2><a name="app-settings">Application Settings</a></h2>
|
|
||||||
|
|
||||||
<p>The settings editor is divided into four tabs. Changes aren't pushed
|
<p>The settings editor is divided into four tabs. Changes aren't pushed
|
||||||
out to the main application until you hit Apply or OK.</p>
|
out to the main application until you hit Apply or OK.</p>
|
||||||
|
|
||||||
@ -44,14 +38,14 @@ out to the main application until you hit Apply or OK.</p>
|
|||||||
<p>These settings change the way the code looks on screen.</p>
|
<p>These settings change the way the code looks on screen.</p>
|
||||||
|
|
||||||
<p>Click the Column Visibility buttons to hide columns. Click them
|
<p>Click the Column Visibility buttons to hide columns. Click them
|
||||||
again to restore the column to a default width. A "hidden" column just
|
again to restore the column to a width appropriate for the current font.
|
||||||
has a width of zero, so with careful mouse positioning you can show and
|
A "hidden" column just has a width of zero, so with careful mouse
|
||||||
hide columns from the code list. The buttons may be more convenient
|
positioning you can show and hide columns from the code list. The buttons
|
||||||
though.</p>
|
may be more convenient though.</p>
|
||||||
|
|
||||||
<p>You can select a different font for the code list. Make it as large
|
<p>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
|
or small as you want. Mono-space fonts like Courier or Consolas are
|
||||||
recommended.</p>
|
recommended (and will be the only ones shown).</p>
|
||||||
|
|
||||||
<p>You can choose to display different parts of the display in upper or
|
<p>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
|
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.)</p>
|
|||||||
|
|
||||||
<p>If you enable "identify assembler in output", a comment will be
|
<p>If you enable "identify assembler in output", a comment will be
|
||||||
added to the top of the generated assembly output that identifies the
|
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
|
file is sent to other people, since it may not otherwise be obvious from
|
||||||
the source file what the intended target assembler is.</p>
|
the source file what the intended target assembler is, or what options
|
||||||
|
are required to process the file correctly.</p>
|
||||||
|
|
||||||
<p>"Disable label localization" turns off the
|
<p>"Disable label localization" turns off the
|
||||||
<a href="codegen.html#localizer">label localizer</a>.</p>
|
<a href="codegen.html#localizer">label localizer</a>.</p>
|
||||||
@ -156,9 +152,15 @@ with the combox box, then click "set" to set the fields.</p>
|
|||||||
|
|
||||||
<h2><a name="project-properties">Project Properties</a></h2>
|
<h2><a name="project-properties">Project Properties</a></h2>
|
||||||
|
|
||||||
|
<p>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.</p>
|
||||||
|
|
||||||
<p>The properties editor is divided into four tabs. Changes aren't pushed
|
<p>The properties editor is divided into four tabs. Changes aren't pushed
|
||||||
out to the main application until you close the dialog. Clicking Apply
|
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.</p>
|
you later hit Cancel, but the changes are not applied immediately.</p>
|
||||||
<p>All changes are subject to undo/redo.</p>
|
<p>All changes are subject to undo/redo.</p>
|
||||||
|
|
||||||
@ -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
|
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
|
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
|
are treated as invalid and cause the code analyzer to assume that it
|
||||||
has run into a data area.</p>
|
has run into a data area. This option has no effect on the 65816.</p>
|
||||||
|
|
||||||
<p>The entry flags determine the initial value for the processor status
|
<p>The entry flags determine the initial value for the processor status
|
||||||
flag register. Code that is unreachable internally (requiring a code
|
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.</p>
|
65816 code, where the initial value of the M/X/E flags is significant.</p>
|
||||||
|
|
||||||
<p>If "analyze uncategorized data" is checked, SourceGen will attempt to
|
<p>If "analyze uncategorized data" is checked, SourceGen will attempt to
|
||||||
|
@ -32,8 +32,8 @@ limitations under the License.
|
|||||||
<TextBox Margin="0,8,0,0" IsReadOnly="True" Text="{Binding Message}"/>
|
<TextBox Margin="0,8,0,0" IsReadOnly="True" Text="{Binding Message}"/>
|
||||||
<DockPanel Margin="0,8,0,0" LastChildFill="False">
|
<DockPanel Margin="0,8,0,0" LastChildFill="False">
|
||||||
<TextBlock DockPanel.Dock="Left" Text="Do you want to locate the data file?"/>
|
<TextBlock DockPanel.Dock="Left" Text="Do you want to locate the data file?"/>
|
||||||
<Button DockPanel.Dock="Right" Content="Cancel" Width="75" Margin="8,0,0,0" IsCancel="True"/>
|
<Button DockPanel.Dock="Right" Content="Cancel" Width="70" Margin="8,0,0,0" IsCancel="True"/>
|
||||||
<Button DockPanel.Dock="Right" Grid.Column="1" Content="OK" Width="75"
|
<Button DockPanel.Dock="Right" Grid.Column="1" Content="OK" Width="70"
|
||||||
IsDefault="True" Click="OkButton_Click"/>
|
IsDefault="True" Click="OkButton_Click"/>
|
||||||
</DockPanel>
|
</DockPanel>
|
||||||
</StackPanel>
|
</StackPanel>
|
||||||
|
@ -34,8 +34,8 @@ limitations under the License.
|
|||||||
</TextBlock>
|
</TextBlock>
|
||||||
<StackPanel DockPanel.Dock="Bottom" Margin="0,8,0,0"
|
<StackPanel DockPanel.Dock="Bottom" Margin="0,8,0,0"
|
||||||
Orientation="Horizontal" HorizontalAlignment="Right">
|
Orientation="Horizontal" HorizontalAlignment="Right">
|
||||||
<Button Name="okButton" Width="75" Content="Continue" IsDefault="True"/>
|
<Button Name="okButton" Width="70" Content="Continue" IsDefault="True"/>
|
||||||
<Button Name="cancelButton" Margin="8,0,0,0" Width="75" Content="Cancel" IsCancel="True"/>
|
<Button Name="cancelButton" Margin="8,0,0,0" Width="70" Content="Cancel" IsCancel="True"/>
|
||||||
</StackPanel>
|
</StackPanel>
|
||||||
</DockPanel>
|
</DockPanel>
|
||||||
</Window>
|
</Window>
|
||||||
|
@ -28,7 +28,7 @@ limitations under the License.
|
|||||||
<StackPanel Margin="8">
|
<StackPanel Margin="8">
|
||||||
<TextBlock Name="messageText" HorizontalAlignment="Left" Text="Preparing..."/>
|
<TextBlock Name="messageText" HorizontalAlignment="Left" Text="Preparing..."/>
|
||||||
<ProgressBar Name="progressBar" Width="600" Height="23" Margin="0,8,0,0"/>
|
<ProgressBar Name="progressBar" Width="600" Height="23" Margin="0,8,0,0"/>
|
||||||
<Button Name="cancelButton" Width="75" Margin="0,8,0,0" HorizontalAlignment="Center"
|
<Button Name="cancelButton" Width="70" Margin="0,8,0,0" HorizontalAlignment="Center"
|
||||||
Content="Cancel" Click="CancelButton_Click"/>
|
Content="Cancel" Click="CancelButton_Click"/>
|
||||||
</StackPanel>
|
</StackPanel>
|
||||||
</Window>
|
</Window>
|
||||||
|
Loading…
Reference in New Issue
Block a user