diff options
| author | Sam Davis | 2016-09-13 18:37:27 +0000 |
|---|---|---|
| committer | Sam Davis | 2016-09-13 20:13:54 +0000 |
| commit | 77472c5c8b76d3d8c59ce8351ad72e88e01e5cb0 (patch) | |
| tree | b5cb04a80fda994793486694238d4f961e5d9b40 | |
| parent | 0a35b4ee026402d527bf59d5ce42f3df53ed36e3 (diff) | |
| download | org.eclipse.mylyn.tasks-77472c5c8b76d3d8c59ce8351ad72e88e01e5cb0.tar.gz org.eclipse.mylyn.tasks-77472c5c8b76d3d8c59ce8351ad72e88e01e5cb0.tar.xz org.eclipse.mylyn.tasks-77472c5c8b76d3d8c59ce8351ad72e88e01e5cb0.zip | |
497534: update userguide
Change-Id: I4cc673dbdde77ced2016c3c19c8c5817ff8906bd
Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=497534
6 files changed, 43 insertions, 40 deletions
diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html index 2eba031ae..f70c6e453 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html @@ -104,11 +104,14 @@ </p> <p><table> <th>Eclipse Version</th><th>Mylyn Version</th> -<tr><td>4.2 (Juno)</td><td>3.7 and later</td></tr> +<tr><td>4.5</td><td>3.16 and later</td></tr> +<tr><td>4.4</td><td>3.10 - 3.18</td></tr> +<tr><td>4.3</td><td>3.10 - 3.16</td></tr> +<tr><td>4.2 (Juno)</td><td>3.7 - 3.10</td></tr> <tr><td>4.1</td><td>Not Supported</td></tr> <tr><td>4.0</td><td>Not Supported</td></tr> <tr><td>3.8</td><td>3.7 and later</td></tr> -<tr><td>3.7 (Indigo)</td><td>3.5 and later</td></tr> +<tr><td>3.7 (Indigo)</td><td>3.5 - 3.9</td></tr> <tr><td>3.6 (Helios)</td><td>3.3 - 3.8</td></tr> <tr><td>3.5 (Galileo)</td><td>3.2 - 3.6</td></tr> <tr><td>3.4 (Ganymede)</td><td>2.1 - 3.4</td></tr> @@ -177,23 +180,23 @@ <li>Trac 0.9, 0.10, 0.11, 0.12</li> </ul> <h2 id="What_version_of_Java_is_required.3F">What version of Java is required?</h2> - <p>Mylyn needs the - <b>Java 5</b> virtual machine. + <p>Each Mylyn version has its own specified Java requirements which can be found on the version's review pages. For example, + <a href="https://projects.eclipse.org/projects/mylyn/releases/3.19/review" target="mylyn_external"> Mylyn 3.19</a> requires Java 7 or later. </p> - <p>To check the version of the Java virtual machine that Eclipse was launched with to to - <i>Help → About Eclipse SDK → Configuration Details</i> and verify that the java.vm.version is 1.5. + <p>To check the version of the Java virtual machine that Eclipse was launched with go to + <i>Help → About Eclipse SDK → Configuration Details</i> and verify that it meets those requirements. </p> <p>Mac users should refer to the last comment on <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=116347#c4" target="mylyn_external">bug 1163477</a> for instructions on how to change the 1.4 default. </p> <ul> - <li>If you do not have Java 5, you can download it from - <a href="http://72.5.124.55/javase/downloads/index.jsp" target="mylyn_external">Sun’s web site</a>. + <li>If you do not have the required Java version, you can download it from + <a href="https://java.com/en/download/" target="mylyn_external">Oracle’s web site</a>. </li> - <li>If you have more than one VM, you need to specify that Eclipse should use the JDK1.5 VM. </li> + <li>If you have more than one VM, you need to specify that Eclipse should use the correct JDK VM. </li> </ul> - <p>In Unix, set the environment variable <code>JAVA_HOME</code> to the root of the JDK1.5 installation and/or set the <code>PATH</code> variable to put the JDK1.5 executable directory before any other VM executable directories. For example, under <code>bash</code> in Unix:</p> - <pre>export JAVA_HOME="<i>(location of JDK1.5 root)</i>" + <p>In Unix, set the environment variable <code>JAVA_HOME</code> to the root of the JDK installation and/or set the <code>PATH</code> variable to put the JDK executable directory before any other VM executable directories. For example, under <code>bash</code> in Unix:</p> + <pre>export JAVA_HOME="<i>(location of JDK root)</i>" export PATH=$JAVA_HOME/bin:$PATH </pre> <p><b>We do @@ -243,7 +246,7 @@ J2SE-1.3,J2SE-1.4,J2SE-1.5,JavaSE-1.6 <i>Window → Show View → Other</i>, then select <i>Mylyn</i> and you should see the available Mylyn Views. </li> - <li>If you still don’t see anything, then perhaps you aren’t using the JDK1.5 VM (or later). See + <li>If you still don’t see anything, then perhaps you aren’t using the required JDK VM. See <a href="http://wiki.eclipse.org/Mylyn_Installation_Guide#Download_and_configure_Java" title="Mylyn_Installation_Guide#Download_and_configure_Java" target="mylyn_external">configuring Java</a>. </li> </ol> @@ -265,7 +268,7 @@ J2SE-1.3,J2SE-1.4,J2SE-1.5,JavaSE-1.6 <p>It probably means that you are on MacOS, and for some reason are missing Xerces from the Mac JDK1.5. You will probably need to add it to your default classpath. Please refer to and comment on <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=144287" target="mylyn_external">bug 144287</a> if you see this problem. </p> - <p>To ensure that you are using the 1.5 VM refer to the last comment on + <p>To ensure that you are using the required VM refer to the last comment on <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=116347#c4" target="mylyn_external">bug 1163477</a> for instructions on how to change the 1.4 default. </p> <p> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html index 9c96ce68f..ef82c2f10 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html @@ -94,7 +94,7 @@ <b>Automatically create and manage with task context</b> - Enables automatic change set management. Change sets will be created automatically so that you can commit or update only resources that are in a task's context. </li> <li> - <b>Commit Message Template</b> - Set the values that will appear in commit messages that are automatically generated when committing resources associated with a task. + <b>Commit Message Template</b> - Set the values that will appear in commit messages that are automatically generated when committing resources associated with a task. Pressing Ctrl+Space activates content assist which displays a list of the variables. Clicking once on a variable shows a description of that variable. For example, the variable ${task.id} provides the ID of the task associated with the commit. </li> </ul><hr class="navigation-separator"/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html index 5a13cd3f0..66ff25258 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html @@ -61,7 +61,7 @@ </li> </ul> <h2 id="Automatic_Commit_Messages">Automatic Commit Messages</h2> - <p>When using task-focused change sets as described above, commit messages are automatically be generated based on the task whose resources are being commited. By default, the commit message includes information such as the task ID, description, and URL. To change the template for these commit messages, navigate to Window -> Preferences -> Tasks -> Team.</p> + <p>When using task-focused change sets as described above, commit messages are automatically be generated based on the task whose resources are being commited. By default, the commit message includes information such as the task ID, description, and URL. To change the template for these commit messages, navigate to Window -> Preferences -> Mylyn -> Team.</p> <p>Note that for EGit, Task-focused Change Sets are not supported, however the commit message will be populated based on your currently active task.</p> <h2 id="Working_with_Patches">Working with Patches</h2> <p>When applying patches, the preferred scenario is to have a task context attached to the task along with the patch. Since this is not always feasible, Mylyn provides an action in the popup menu of the diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html index 959d4c35c..8cf0ed0e9 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html @@ -409,7 +409,7 @@ <b>Synchronize Changed</b> - Updates the task list with any changes on the task repository. </li> <li> - <b>Synchronize Automatically</b> - When checked, the task list will update from the task repository on an interval specified in Window -> Preferences -> Tasks -> Synchronization + <b>Synchronize Automatically</b> - When checked, the task list will update from the task repository on an interval specified in Window -> Preferences -> Mylyn -> Tasks </li> <li> <b>Show UI Legend</b> - Displays a legend explaining icons and color-coding. diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png Binary files differindex 960138276..122892ae9 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png diff --git a/org.eclipse.mylyn.help.ui/org.eclipse.mylyn.help.ui build-helper.xml.launch b/org.eclipse.mylyn.help.ui/org.eclipse.mylyn.help.ui build-helper.xml.launch index 1fd1347cf..7792832e1 100644 --- a/org.eclipse.mylyn.help.ui/org.eclipse.mylyn.help.ui build-helper.xml.launch +++ b/org.eclipse.mylyn.help.ui/org.eclipse.mylyn.help.ui build-helper.xml.launch @@ -1,24 +1,24 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType"> -<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="true"/> -<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS"> -<listEntry value="/org.eclipse.mylyn.help.ui/build-helper.xml"/> -</listAttribute> -<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES"> -<listEntry value="1"/> -</listAttribute> -<listAttribute key="org.eclipse.jdt.launching.CLASSPATH"> -<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry containerPath="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jre6" path="1" type="4"/> "/> -<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.ant.ui.classpathentry.antHome"> <memento default="true"/> </runtimeClasspathEntry> "/> -<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.ant.ui.classpathentry.extraClasspathEntries"> <memento/> </runtimeClasspathEntry> "/> -<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.jdt.launching.classpathentry.variableClasspathEntry"> <memento path="3" variableString="${project_classpath:org.eclipse.mylyn.help.ui}"/> </runtimeClasspathEntry> "/> -</listAttribute> -<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/> -<booleanAttribute key="org.eclipse.jdt.launching.DEFAULT_CLASSPATH" value="false"/> -<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jdk1.8.0_60"/> -<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/> -<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.mylyn.help.ui"/> -<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/> -<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.mylyn.help.ui/build-helper.xml}"/> -<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/> -</launchConfiguration> +<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
+<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="true"/>
+<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+<listEntry value="/org.eclipse.mylyn.help.ui/build-helper.xml"/>
+</listAttribute>
+<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+<listEntry value="1"/>
+</listAttribute>
+<listAttribute key="org.eclipse.jdt.launching.CLASSPATH">
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry containerPath="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jre6" path="1" type="4"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.ant.ui.classpathentry.antHome"> <memento default="true"/> </runtimeClasspathEntry> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.ant.ui.classpathentry.extraClasspathEntries"> <memento/> </runtimeClasspathEntry> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.jdt.launching.classpathentry.variableClasspathEntry"> <memento path="3" variableString="${project_classpath:org.eclipse.mylyn.tasks.ui}"/> </runtimeClasspathEntry> "/>
+</listAttribute>
+<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
+<booleanAttribute key="org.eclipse.jdt.launching.DEFAULT_CLASSPATH" value="false"/>
+<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jdk1.8.0_60"/>
+<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
+<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.mylyn.help.ui"/>
+<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.mylyn.help.ui/build-helper.xml}"/>
+<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
+</launchConfiguration>
|
