Skip to content

Commit 0917374

Browse files
committed
some documentation cleanup
1 parent 447c7c6 commit 0917374

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

Changelog.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Version 7.0.0
22
- Added Spin2 structures (basically small objects)
33
- Added BOOL debug modifier for -g
44
- Added some of the v44 Spin2 builtin methods like byteswap
5+
- Added warning for rep without @
56
- Cleaned up the Spin parser to enable direct access to struct/obj members
67
- Fixed long relative branches (tjz, djnz, etc.)
78
- Fixed incorrect handling of simple for loops with unsigned variables

doc/spin.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ Unlike the "official" Spin2 compiler, flexspin does not accept an address for th
420420
421421
(3) The area set aside for inline assembly is smaller by default in flexspin than in Parallax's Spin2. This may be changed with the --fcache parameter to flexspin.
422422
423-
(4) In PNut/PropTool only the first 16 local variables may be accessed in inline assembly; flexspin has this restriction only for bytecode output, for assembly output other locals may be accessed as well.
423+
(4) In PNut/PropTool only the first 16 local variables may be accessed in inline assembly; flexspin has this restriction only for bytecode output. For assembly output other locals may be accessed as well.
424424
425425
### Method pointers
426426
@@ -807,15 +807,15 @@ There are some work-arounds to reduce the impact of this, so it probably will on
807807
808808
Many Spin1 programs may be ported from the Propeller 1 to the Propeller 2, but there are some important exceptions:
809809
810-
- PASM must be translated to P2ASM. The assembly language for the Propeller 1 and Propeller 2 are different; there are some similarities, but in general any assembly language code will have to be translated to work on the different processor.
810+
- PASM must be converted to P2ASM. The assembly language for the Propeller 1 and Propeller 2 are different; there are some similarities, but in general any assembly language code will have to be translated ``by hand'' to work on the different processor.
811811
812812
- WAITPEQ, WAITPNE, and WAITVID are not implemented on P2
813813
814814
- The hardware register set is different; the P2 does not have the CTRx, FRQx, PHSx, VCFG, or VSCL registers.
815815
816816
## Compatibility with PropTool
817817
818-
flexspin is mostly, but not completely, compatible with the standard Spin2 compiler. Not all Spin2 builtin functions are available on the P1; only the ones listed in the "New intrinsics for both P1 and P2" are available on all platforms. But when compiling for P2 all of the Spin2 builtin functions should be available.
818+
flexspin is mostly, but not completely, compatible with the standard Spin2 compiler. Not all Spin2 builtin functions are available on the P1; only the ones listed in the "New intrinsics for both P1 and P2" are available on all platforms. But when compiling for P2 all of the Spin2 builtin functions should be available, unless otherwise noted.
819819
820820
### Layout of variables in memory
821821
@@ -833,7 +833,7 @@ The flexspin parser works differently from the PNut parser, and in complicated n
833833
834834
- In general try not to nest expressions involving `:`
835835
- Do not use `:` in `lookup`/`lookdown` type expressions except as the separator between the selection expression and the list of results
836-
- Make liberal use of parentheses to resolve ambiguity, e.g. write `a ? (b()) : 1` or `a ? (b():1) : 2` to distinguish between `:1` as an indirect method marker nad `:1` as the "else" part of the `?` operator.
836+
- Make liberal use of parentheses to resolve ambiguity, e.g. write `a ? (b()) : 1` or `a ? (b():1) : 2` to distinguish between `:1` as an indirect method marker and `:1` as the "else" part of the `?` operator.
837837
838838
### ORG/END
839839
@@ -857,7 +857,7 @@ Debug statements are output only when some variant of the `-g` flag (e.g. `-g` o
857857
858858
Only a subset of the Spin2 `DEBUG` directives are accepted in normal `-g` mode:
859859
```
860-
ZSTR, UDEC, UDEC_BYTE, UDEC_WORD, UDEC_LONG, SDEC, SDEC_BYTE, SDEC_WORD, SDEC_LONG, UHEX, UHEX_BYTE, UHEX_WORD, UHEX_LONG, DLY
860+
ZSTR, UDEC, UDEC_BYTE, UDEC_WORD, UDEC_LONG, SDEC, SDEC_BYTE, SDEC_WORD, SDEC_LONG, UHEX, UHEX_BYTE, UHEX_WORD, UHEX_LONG, BOOL, DLY
861861
```
862862
Other debug directives are ignored, with a warning.
863863
@@ -877,4 +877,4 @@ The `REGLOAD` and `REGEXEC` Spin2 instructions are not supported at this time, m
877877
878878
### Detecting FlexSpin versus PNut
879879
880-
FlexSpin understands a special comments that start with `{$flexspin` and treats these as regular code. PNut will ignore these comments, so this provides a way to mix FlexSpin specific code and PNut specific code. See the preprocessor section above ("Special Preprocessor Comments") for further details and an example.
880+
FlexSpin understands special comments that start with `{$flexspin` and treats these as regular code. PNut will ignore these comments, so this provides a way to mix FlexSpin specific code and PNut specific code. See the preprocessor section above ("Special Preprocessor Comments") for further details and an example.

0 commit comments

Comments
 (0)