platform-core-home/downloads/tools/readme_restorer_1.0.0.html
Parent Directory
| 
Revision Log
Revision 1.2 - (view) (download) (as text)
| 1 : | dj | 1.1 | <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"> |
| 2 : | <html> | ||
| 3 : | <head> | ||
| 4 : | <title>Workspace Re-Builder Plug-in</title> | ||
| 5 : | </head> | ||
| 6 : | |||
| 7 : | <body><center> | ||
| 8 : | <h2>Workspace Re-Builder Plug-in (version 1.0.0)</h2> | ||
| 9 : | </center> | ||
| 10 : | |||
| 11 : | <p align="right"><i>Last updated: 2003-06-20</i></p> | ||
| 12 : | |||
| 13 : | <h3>Introduction</h3> | ||
| 14 : | |||
| 15 : | <blockquote> | ||
| 16 : | <p>Your workspace is corrupt and Eclipse won't start. You don't know what happened...you | ||
| 17 : | got an OutOfMemoryError, you ran out of disk space, your dog was playing with | ||
| 18 : | the power switch on the CPU. All you know is that you have a lot of projects | ||
| 19 : | in your (now corrupt) workspace and you don't want to re-build your workspace | ||
| 20 : | from scratch.</p> | ||
| 21 : | <p>Now the Platform/Core team offers this utility plug-in which can perform | ||
| 22 : | the basic restoration of your workspace. We cannot restore all metadata, but | ||
| 23 : | we will attempt to re-create your projects in your workspace.</p> | ||
| 24 : | </blockquote> | ||
| 25 : | |||
| 26 : | <h3>Before you start</h3> | ||
| 27 : | <blockquote> | ||
| 28 : | <p>Please note that this utility only re-builds workspaces which were created | ||
| 29 : | in Eclipse 2.0 and later. Restoration of workspaces from Eclipse 1.0 will | ||
| 30 : | not work.</p> | ||
| 31 : | <p> | ||
| 32 : | </blockquote> | ||
| 33 : | |||
| 34 : | <h3>Setup</h3> | ||
| 35 : | <blockquote> Download the zip file from the web site and extract it to the <code>plugins</code> | ||
| 36 : | directory of your install. For instance: | ||
| 37 : | <blockquote> | ||
| 38 : | <code>unzip org.eclipse.core.tools.restorer_1.0.0.zip -d /home/eclipse/plugins</code> | ||
| 39 : | </blockquote> | ||
| 40 : | <p> | ||
| 41 : | </blockquote> | ||
| 42 : | |||
| 43 : | <h3>Using the Utility</h3> | ||
| 44 : | <blockquote> | ||
| 45 : | <p>The workspace re-builder operates in-place. To start it you only have to | ||
| 46 : | set the <tt>-application</tt> argument.</p> | ||
| 47 : | <blockquote> | ||
| 48 : | <p><code>eclipse -application org.eclipse.core.tools.restorer.application</code></p> | ||
| 49 : | </blockquote> | ||
| 50 : | Note if you currently start Eclipse with a shortcut specifying the your workspace | ||
| 51 : | (via -data) then you must supply this as well. | ||
| 52 : | <blockquote> | ||
| 53 : | <p> | ||
| 54 : | <code>eclipse -application org.eclipse.core.tools.restorer.application -data myworkspace</code> | ||
| 55 : | <p> | ||
| 56 : | </blockquote> | ||
| 57 : | </blockquote> | ||
| 58 : | |||
| 59 : | <h3>After Running the Utility</h3> | ||
| 60 : | <blockquote> | ||
| 61 : | <p>Each plug-in which contributes a restorer will have a copy of their old metadata | ||
| 62 : | directory as a backup. So if you had a metadata area on disk which looked | ||
| 63 : | like the following:</p> | ||
| 64 : | <p> | ||
| 65 : | <code> | ||
| 66 : | workspace<br> | ||
| 67 : | .metadata<br> | ||
| 68 : | .plugins<br> | ||
| 69 : | org.eclipse.core.resources<br> | ||
| 70 : | org.eclipse.jdt.core<br> | ||
| 71 : | org.eclipse.ui | ||
| 72 : | </code> | ||
| 73 : | <p> Then it will look like this after you run the restorer with the default | ||
| 74 : | resources plug-in fragment: | ||
| 75 : | <P> | ||
| 76 : | <code> | ||
| 77 : | workspace<br> | ||
| 78 : | .metadata<br> | ||
| 79 : | .plugins<br> | ||
| 80 : | org.eclipse.core.resources<br> | ||
| 81 : | org.eclipse.core.resources.<timestamp><br> | ||
| 82 : | org.eclipse.jdt.core<br> | ||
| 83 : | org.eclipse.ui<br> | ||
| 84 : | </code> | ||
| 85 : | <p> The corrupt data is in the <code>org.eclipse.core.resources.<timestamp</code>> | ||
| 86 : | directory. | ||
| 87 : | <p> | ||
| 88 : | </blockquote> | ||
| 89 : | |||
| 90 : | <h3>What Does It Do?</h3> | ||
| 91 : | <blockquote> What it restores: | ||
| 92 : | <ul> | ||
| 93 : | <li>the <b>basic</b> state of all your projects that you had in your old workspace | ||
| 94 : | </ul> | ||
| 95 : | <p> What it doesn't restore: | ||
| 96 : | |||
| 97 : | <ul> | ||
| 98 : | <li>your workbench preferences | ||
| 99 : | <li>bookmarks, tasks, problems, and other markers | ||
| 100 : | <li>repository synchronization information from your shared projects | ||
| 101 : | <li>other plug-in specific metadata | ||
| 102 : | </ul> | ||
| 103 : | <p> | ||
| 104 : | |||
| 105 : | </blockquote> | ||
| 106 : | |||
| 107 : | <h3>Considerations for Restoration Contributors</h3> | ||
| 108 : | <blockquote> The key point to remember when writing a workspace restoration contributor | ||
| 109 : | is the fact that we are trying to restore a corrupt workspace. We don't know | ||
| 110 : | what caused the workspace to become corrupt nor do we know which files in the | ||
| 111 : | metadata are corrupt. Attempts should be made to verify that metadata files | ||
| 112 : | are in working order and no assumptions should be made about the validity of | ||
| 113 : | any files on disk. | ||
| 114 : | <p> | ||
| 115 : | </blockquote> | ||
| 116 : | |||
| 117 : | <h3>Future Work</h3> | ||
| 118 : | <blockquote> Our plug-in offers an extension point where plug-ins can contribute | ||
| 119 : | their own restorers. The stand-alone utility will create your projects for you, | ||
| 120 : | and then other plug-ins can re-create any state that they know about. Future | ||
| 121 : | work includes working with other teams to get their restorers working, as well | ||
| 122 : | as improving the one provided for the <code>org.eclipse.core.resources</code> | ||
| 123 : | plug-in so it will restore markers, sync info, and persistent properties. | ||
| 124 : | <p> | ||
| 125 : | </blockquote> | ||
| 126 : | |||
| 127 : | <h3>Comments/Bugs</h3> | ||
| 128 : | <blockquote> Comments and questions can be directed to the <a href="mailto:platform-core-dev@eclipse.org">platform-core-dev@eclipse.org</a> | ||
| 129 : | mailing list. Complaints and bug reports can be directed to the <a href="http://bugs.eclipse.org/bugs">Bugzilla | ||
| 130 : | database</a> on <a href="http://eclipse.org">eclipse.org</a> against the <a href="http://bugs.eclipse.org/bugs/enter_bug.cgi?product=Platform">Platform/Core</a> | ||
| 131 : | component. | ||
| 132 : | <p> | ||
| 133 : | </blockquote> | ||
| 134 : | |||
| 135 : | dj | 1.2 | <h3>Disclaimer</h3> |
| 136 : | <blockquote>This plug-in is provided to the user to use at their own risk. No guarentees | ||
| 137 : | are made that the workspace will be able to be restored but if its corrupt then it can't | ||
| 138 : | get any worse! | ||
| 139 : | </blockquote> | ||
| 140 : | |||
| 141 : | dj | 1.1 | <p><a href="hglegal2002.htm"><img SRC="ngibmcpy2002.gif" ALT="Copyright IBM Corporation and others 2000, 2002. All Rights Reserved." BORDER=0 height=14 width=324></a></p> |
| 142 : | </body> | ||
| 143 : | </html> |
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |