Fix typos; other copyediting

This commit is contained in:
Ryan Carsten Schmidt 2023-11-14 00:57:07 -06:00 committed by GitHub
parent d7d1d89698
commit e9e3cd969e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 24 deletions

View File

@ -184,7 +184,7 @@ Here is a description of all the command line options:
<label id="option--mnemonic-column"> <label id="option--mnemonic-column">
<tag><tt>--mnemonic-column n</tt></tag> <tag><tt>--mnemonic-column n</tt></tag>
Specifies the column where a mnemonic or pseudo instrcuction is output. Specifies the column where a mnemonic or pseudo instruction is output.
<label id="option--pagelength"> <label id="option--pagelength">
@ -283,7 +283,7 @@ Some instructions may generate labels in the first pass, while most other
instructions do not generate labels, but use them if they are available. Among instructions do not generate labels, but use them if they are available. Among
others, the branch and jump instructions will generate labels for the target others, the branch and jump instructions will generate labels for the target
of the branch in the first pass. External labels (taken from the info file) of the branch in the first pass. External labels (taken from the info file)
have precedence over internally generated ones, They must be valid identifiers have precedence over internally generated ones. They must be valid identifiers
as specified for the ca65 assembler. Internal labels (generated by the as specified for the ca65 assembler. Internal labels (generated by the
disassembler) have the form <tt/Labcd/, where <tt/abcd/ is the hexadecimal disassembler) have the form <tt/Labcd/, where <tt/abcd/ is the hexadecimal
address of the label in upper case letters. You should probably avoid using address of the label in upper case letters. You should probably avoid using
@ -304,7 +304,7 @@ name="next section"> for more information.
The info file contains lists of specifications grouped together. Each group The info file contains lists of specifications grouped together. Each group
directive has an identifying token and an attribute list enclosed in curly directive has an identifying token and an attribute list enclosed in curly
braces. Attributes have a name followed by a value. The syntax of the value braces. Attributes have a name followed by a value. The syntax of the value
depends on the type of the attribute. String attributes are places in double depends on the type of the attribute. String attributes are placed in double
quotes, numeric attributes may be specified as decimal numbers or hexadecimal quotes, numeric attributes may be specified as decimal numbers or hexadecimal
with a leading dollar sign. There are also attributes where the attribute with a leading dollar sign. There are also attributes where the attribute
value is a keyword; in this case, the keyword is given as-is (without quotes or value is a keyword; in this case, the keyword is given as-is (without quotes or
@ -317,8 +317,8 @@ anything). Each attribute is terminated by a semicolon.
<sect1>Comments<p> <sect1>Comments<p>
Comments start with a hash mark (<tt/#/) or a double slash (<tt>//</tt>); Comments start with a hash mark (<tt/#/) or a double slash (<tt>//</tt>)
and, extend from the position of the mark to the end of the current line. and extend from the position of the mark to the end of the current line.
Hash marks or double slashes inside of strings will <em/not/ start a comment, Hash marks or double slashes inside of strings will <em/not/ start a comment,
of course. of course.
@ -359,20 +359,20 @@ following attributes are recognized:
<tag><tt/HEXOFFS/</tag> <tag><tt/HEXOFFS/</tag>
The attribute is followed by a boolean value. If true, offsets to labels are This attribute is followed by a boolean value. If true, offsets to labels are
output in hex, otherwise they're output in decimal notation. The default is output in hex, otherwise they're output in decimal notation. The default is
false. The attribute may be changed on the command line using the <tt><ref false. The attribute may be changed on the command line using the <tt><ref
id="option--hexoffs" name="--hexoffs"></tt> option. id="option--hexoffs" name="--hexoffs"></tt> option.
<tag><tt/INPUTNAME/</tag> <tag><tt/INPUTNAME/</tag>
The attribute is followed by a string value, which gives the name of the This attribute is followed by a string value, which gives the name of the
input file to read. If it is present, the disassembler does not accept an input file to read. If it is present, the disassembler does not accept an
input file name on the command line. input file name on the command line.
<tag><tt/INPUTOFFS/</tag> <tag><tt/INPUTOFFS/</tag>
The attribute is followed by a numerical value that gives an offset into This attribute is followed by a numerical value that gives an offset into
the input file which is skipped before reading data. The attribute may be the input file which is skipped before reading data. The attribute may be
used to skip headers or unwanted code sections in the input file. used to skip headers or unwanted code sections in the input file.
@ -412,7 +412,7 @@ following attributes are recognized:
<label id="OUTPUTNAME"> <label id="OUTPUTNAME">
<tag><tt/OUTPUTNAME/</tag> <tag><tt/OUTPUTNAME/</tag>
The attribute is followed by string value, which gives the name of the This attribute is followed by string value, which gives the name of the
output file to write. If it is present, specification of an output file on output file to write. If it is present, specification of an output file on
the command line using the <tt><ref id="option-o" name="-o"></tt> option is the command line using the <tt><ref id="option-o" name="-o"></tt> option is
not allowed. not allowed.
@ -433,8 +433,8 @@ following attributes are recognized:
This attribute may be used instead of the <tt><ref id="option--start-addr" This attribute may be used instead of the <tt><ref id="option--start-addr"
name="--start-addr"></tt> option on the command line. It takes a numerical name="--start-addr"></tt> option on the command line. It takes a numerical
parameter. The default for the start address is $10000 minus the size of parameter. The default for the start address is $10000 minus the size of
the input file (this assumes that the input file is a ROM that contains the the input file. (This assumes that the input file is a ROM that contains the
reset and irq vectors). reset and irq vectors.)
<tag><tt/TEXTCOLUMN/</tag> <tag><tt/TEXTCOLUMN/</tag>
@ -468,7 +468,7 @@ following attributes are recognized:
<tag><tt>NAME</tt></tag> <tag><tt>NAME</tt></tag>
This is a convenience attribute. It takes a string argument and will cause This is a convenience attribute. It takes a string argument and will cause
the disassembler to define a label for the start of the range with the the disassembler to define a label for the start of the range with the
given name. So a separate <tt><ref id="infofile-label" name="LABEL"></tt> given name so a separate <tt><ref id="infofile-label" name="LABEL"></tt>
directive is not needed. directive is not needed.
<tag><tt>START</tt></tag> <tag><tt>START</tt></tag>
@ -509,8 +509,8 @@ following attributes are recognized:
<tag><tt>SKIP</tt></tag> <tag><tt>SKIP</tt></tag>
The range is simply ignored when generating the output file. Please note The range is simply ignored when generating the output file. Please note
that this means that reassembling the output file will <em/not/ generate that this means that reassembling the output file will <em/not/ generate
the original file, not only because the missing piece in between, but also the original file, not only because of the missing piece in between, but
because the following code will be located on wrong addresses. Output also because the following code will be located on wrong addresses. Output
generated with <tt/SKIP/ ranges will need manual rework. generated with <tt/SKIP/ ranges will need manual rework.
<tag><tt>TEXTTABLE</tt></tag> <tag><tt>TEXTTABLE</tt></tag>
@ -529,7 +529,7 @@ following attributes are recognized:
<tag><tt>ADDRMODE</tt></tag> <tag><tt>ADDRMODE</tt></tag>
When disassembling 65816 code, this specifies the M and X flag states When disassembling 65816 code, this specifies the M and X flag states
for this range. It's a string argument of the form "mx", capital letters for this range. It's a string argument of the form "mx". Capital letters
mean the flag is enabled. mean the flag is enabled.
</descrip> </descrip>
@ -561,9 +561,9 @@ code. The following attributes are recognized:
<tag><tt>NAME</tt></tag> <tag><tt>NAME</tt></tag>
The attribute is followed by a string value which gives the name of the The attribute is followed by a string value which gives the name of the
label. Empty names are allowed, in this case the disassembler will create label. Empty names are allowed; in this case the disassembler will create
an unnamed label (see the assembler docs for more information about unnamed an unnamed label. (See the assembler docs for more information about unnamed
labels). labels.)
<tag><tt>SIZE</tt></tag> <tag><tt>SIZE</tt></tag>
This attribute is optional and may be used to specify the size of the data This attribute is optional and may be used to specify the size of the data
@ -595,15 +595,18 @@ disassembled code. The following attributes are recognized:
<descrip> <descrip>
<tag><tt>START</tt></tag> <tag><tt>START</tt></tag>
Followed by a numerical value. Specifies the start address of the segment. This attribute is followed by a numerical value which specifies the start
address of the segment.
<tag><tt>END</tt></tag> <tag><tt>END</tt></tag>
Followed by a numerical value. Specifies the end address of the segment. The This attribute is followed by a numerical value which specifies the end
end address is the last address that is a part of the segment. address of the segment. The end address is the last address that is a part of
the segment.
<tag><tt>NAME</tt></tag> <tag><tt>NAME</tt></tag>
The attribute is followed by a string value which gives the name of the This attribute is followed by a string value which gives the name of the
segment. segment.
</descrip> </descrip>
All attributes are mandatory. Segments must not overlap. The disassembler will All attributes are mandatory. Segments must not overlap. The disassembler will
@ -635,10 +638,11 @@ The following attributes are recognized:
<descrip> <descrip>
<tag><tt>FILE</tt></tag> <tag><tt>FILE</tt></tag>
Followed by a string value. Specifies the name of the file to read. This attribute is followed by a string value. It specifies the name of the
file to read.
<tag><tt>COMMENTSTART</tt></tag> <tag><tt>COMMENTSTART</tt></tag>
The optional attribute is followed by a character constant. It specifies the This optional attribute is followed by a character constant. It specifies the
character that starts a comment. The default value is a semicolon. This character that starts a comment. The default value is a semicolon. This
value is ignored if <tt/IGNOREUNKNOWN/ is true. value is ignored if <tt/IGNOREUNKNOWN/ is true.