Docs update. Prepared next release.

This commit is contained in:
Chris Hodges 2021-07-28 08:00:09 +02:00
parent fa1ef0b3d5
commit 8ea70f0dfa
3 changed files with 16 additions and 21 deletions

View File

@ -27,8 +27,8 @@ it's "good enough" to get started, and I can return to demo coding with its curr
- Parser / Lexer for MC68000 (yes, only 68000 right now!) assembly language files in VAsm / DevPac style - Parser / Lexer for MC68000 (yes, only 68000 right now!) assembly language files in VAsm / DevPac style
- Syntax highlighting and Color Settings Page (you should really modify the color settings to your likings!) - Syntax highlighting and Color Settings Page (you should really modify the color settings to your likings!)
- Mnemonics code completion - Mnemonics code completion
- Symbols / Labels code completion - Symbols / Labels / Macros code completion
- References / Refactoring support for local and global labels, and symbol assignments. - References / Refactoring support for local and global labels, symbol assignments, and macros.
- Brace matching - Brace matching
- Quote handler - Quote handler
- Goto Symbol support - Goto Symbol support
@ -36,23 +36,22 @@ it's "good enough" to get started, and I can return to demo coding with its curr
## Known issues ## Known issues
- No referencing of macro invocations and macro definitions. - `Find Usages` always shows _"Unclassified"_ though it shouldn't (?)
- `Find Usages` always shows _"Unclassified"_ though it shouldn't.
- Macro definitions may cause syntax errors when using backslash arguments.
- Macro invocations are not yet evaluated, thus no referencing to symbols defined via macros (e.g. `STRUCT`). - Macro invocations are not yet evaluated, thus no referencing to symbols defined via macros (e.g. `STRUCT`).
- No support for includes. Scoping is for global symbols and labels is currently the whole project. - No support for includes. Scoping is for global symbols and labels is currently the whole project.
- No support for register replacement (e.g. registers replaced by `EQUR` or `EQURL` will cause syntax errors) - No support for register replacement (e.g. registers replaced by `EQUR` or `EQURL` will cause syntax errors)
- While the Lexer supports the -spaces option (where a space introduces a comment), this cannot be configured yet. - While the Lexer supports the -spaces option (where a space introduces a comment), this cannot be configured yet (default is off).
- No support for other processor instructions, FPU or 68020+ address modes. - No support for other processor instructions, FPU or 68020+ address modes.
- No semantic checking for allowed address modes or data widths yet. - No semantic checking for allowed address modes or data widths yet.
- Unit Test coverage is not as good as it could be (ahem). - Unit Test coverage is not as good as it could be (ahem).
- Missing but planned features: - Missing but planned features:
- Macro definition and evaluation on invocation - Macro evaluation on invocation
- Folding - Folding
- Semantic inspections - Semantic inspections
- Quick fixes - Quick fixes
- Formatter + Code Style Settings - Formatter + Code Style Settings
- Register use analysis (but this only makes sense after macro evaluation) - Register use analysis (but this only makes sense after macro evaluation)
- Cycle counting
## Recommendations ## Recommendations
@ -69,7 +68,7 @@ make it work with JUnit 5. Feel free to use the code (in package ```de.platon42.
## Changelog ## Changelog
### V0.3 (unreleased) ### V0.3 (28-Jul-21)
- Enhancement: Macro contents are no longer parsed, added syntax highlighting options for macros. - Enhancement: Macro contents are no longer parsed, added syntax highlighting options for macros.
- Enhancement: Macro definitions are now word and stub indexed, macro calls reference to definition. - Enhancement: Macro definitions are now word and stub indexed, macro calls reference to definition.
@ -84,8 +83,8 @@ make it work with JUnit 5. Feel free to use the code (in package ```de.platon42.
### V0.2 (27-Jul-21) ### V0.2 (27-Jul-21)
- Cosmetics: Added (same) icon for plugin as for file type. - Cosmetics: Added (same) icon for plugin as for file type.
- Performance improvement: Use Word-Index for global labels and symbols instead of iterating over the file. - Performance: Use Word-Index for global labels and symbols instead of iterating over the file.
- Performance improvement: Use Stub-Index for global labels and symbols. - Performance: Use Stub-Index for global labels and symbols.
- Bugfix: No longer reports a syntax error when file lacks terminating End-Of-Line. - Bugfix: No longer reports a syntax error when file lacks terminating End-Of-Line.
- Enhancement: Registers are now offered for code completion, making editing less annoying. - Enhancement: Registers are now offered for code completion, making editing less annoying.

View File

@ -56,7 +56,7 @@ runPluginVerifier {
patchPluginXml { patchPluginXml {
setChangeNotes(""" setChangeNotes("""
<h4>V0.3 (unreleased)</h4> <h4>V0.3 (28-Jul-21)</h4>
<ul> <ul>
<li>Enhancement: Macro contents are no longer parsed, added syntax highlighting options for macros. <li>Enhancement: Macro contents are no longer parsed, added syntax highlighting options for macros.
<li>Enhancement: Macro definitions are now word and stub indexed, macro calls reference to definition. <li>Enhancement: Macro definitions are now word and stub indexed, macro calls reference to definition.
@ -71,15 +71,11 @@ patchPluginXml {
<h4>V0.2 (27-Jul-21)</h4> <h4>V0.2 (27-Jul-21)</h4>
<ul> <ul>
<li>Cosmetics: Added (same) icon for plugin as for file type. <li>Cosmetics: Added (same) icon for plugin as for file type.
<li>Performance improvement: Use Word-Index for global labels and symbols instead of iterating over the file. <li>Performance: Use Word-Index for global labels and symbols instead of iterating over the file.
<li>Performance improvement: Use Stub-Index for global labels and symbols. <li>Performance: Use Stub-Index for global labels and symbols.
<li>Bugfix: No longer reports a syntax error when file lacks terminating End-Of-Line. <li>Bugfix: No longer reports a syntax error when file lacks terminating End-Of-Line.
<li>Enhancement: Registers are now offered for code completion, making editing less annoying. <li>Enhancement: Registers are now offered for code completion, making editing less annoying.
</ul> </ul>
<h4>V0.1 (20-Jul-21)</h4>
<ul>
<li>Initial public release.
</ul>
<p>Full changelog available at <a href="https://github.com/chrisly42/mc68000-asm-plugin#changelog">Github project site</a>.</p> <p>Full changelog available at <a href="https://github.com/chrisly42/mc68000-asm-plugin#changelog">Github project site</a>.</p>
""") """)
} }

View File

@ -10,7 +10,7 @@
<p> <p>
<a href="https://github.com/chrisly42/mc68000-asm-plugin/blob/main/README.md">Full documentation here...</a> <a href="https://github.com/chrisly42/mc68000-asm-plugin/blob/main/README.md">Full documentation here...</a>
]]></description> ]]></description>
<idea-version since-build="193.7288.0"/> <idea-version since-build="193.5233.103"/>
<depends>com.intellij.modules.lang</depends> <depends>com.intellij.modules.lang</depends>