Skip to content

Commit

Permalink
Add Eclipse LWB update instructions to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gohla committed Oct 22, 2021
1 parent 0c132eb commit 5b575f9
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/guide/development/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Development Troubleshooting
# Troubleshooting

This guide explains how to troubleshoot issues when developing Spoofax itself.

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/eclipse_lwb/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Eclipse LWB Troubleshooting
# Troubleshooting

This how-to guide explains how to troubleshoot issues when building and testing languages in the Spoofax Eclipse LWB plugin.

Expand Down
37 changes: 37 additions & 0 deletions docs/guide/eclipse_lwb/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Updating & Downgrading

## Updating

The Spoofax 3 language workbench Eclipse plugin can be updated as follows.
In the main menu of Eclipse, select <span class="guilabel">Help ‣ Install New Software...</span> to open the install dialog.
In this dialog, copy the update site of the version you want to install into the <span class="guilabel">Work with:</span> field and press ++enter++.
If you want to install the latest released version, use this update site:

```
{{release.rel.lwb.eclipse.repository}}
```

In the table below, check the checkbox next to <span class="guilabel">Uncategorized</span> and press <span class="guilabel">Next ></span>.
A dialog will pop up with install details.
Press <span class="guilabel">Finish</span> and wait for Eclipse to install the plugin.

If a <span class="guilabel">Security Warning</span> pops up, press <span class="guilabel">Install anyway</span>, as Spoofax 3 is currently not signed.

Finally, a dialog will pop up asking you to restart Eclipse.
Press <span class="guilabel">Restart Now</span> to restart Eclipse.

## Downgrading

Eclipse does not support directly downgrading to a previous version.
Therefore, we must first uninstall the plugin.

In the main menu, select <span class="guilabel">Help ‣ Install New Software...</span> to open a new dialog.
In this dialog, click the <span class="guilabel">already installed</span> link to open a list of all installed plugins.
In that list, select the <span class="guilabel">Spoofax 3 Language Workbench plugin</span> and press <span class="guilabel">Uninstall...</span>.

A dialog will pop up detailing the uninstall details.
Press <span class="guilabel">Finish</span> and wait for Eclipse to uninstall the plugin.
Finally, a dialog will pop up asking you to restart Eclipse.
Press <span class="guilabel">Restart Now</span> to restart Eclipse.

After Eclipse has restarted, follow the updating instructions above, but instead of using the latest update site, use the update site of an older version instead.
11 changes: 9 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ nav:
- How-to Guides:
- guide/ask_for_help.md
- guide/report_a_bug.md
- guide/eclipse_lwb/troubleshooting.md
- guide/development/troubleshooting.md
- Eclipse LWB:
- guide/eclipse_lwb/update.md
- guide/eclipse_lwb/troubleshooting.md
- Development:
- guide/development/troubleshooting.md
- Reference:
- reference/configuration.md
- Background:
Expand All @@ -34,8 +37,12 @@ theme:
font:
code: JetBrains Mono
features:
- navigation.expand
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.indexes
- navigation.top

extra_css:
Expand Down
4 changes: 2 additions & 2 deletions mkdocs_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs-material==7.1.4
mkdocs-macros-plugin==0.5.5
mkdocs-material==7.3.4
mkdocs-macros-plugin==0.6.0
mkdocs-git-revision-date-plugin==0.3.1
git+https://github.com/metaborg/metaborg-pygments#egg=metaborg-pygments

0 comments on commit 5b575f9

Please sign in to comment.