View source

From Eclipsepedia

for Linux Tools Project/ChangeLog/User Guide

You do not have permission to do that, for the following reason:

The action you have requested is limited to users in the group user.

You can view and copy the source of this page:

= Overview =

The ChangeLog plug-in for Eclipse is a basic set of extensions to enable ChangeLog functionality for projects in Eclipse.

Before using the plug-in, you should set the ChangeLog preferences. These preferences include the name and e-mail address you wish to use in a ChangeLog entry. 

The default name and e-mail address used by the ChangeLog plug-in are your workstation username and your username@hostname information, respectively. If you set the environment variables <code>ECLIPSE_CHANGELOG_REALNAME</code> and/or <code>ECLIPSE_CHANGELOG_EMAIL</code>, the ChangeLog plug-in will use these as the default name and e-mail address instead. 

= ChangeLog Preferences =

To configure your ChangeLog preferences, navigate to <u>Window</u> > <u>Preferences</u> and click <u>ChangeLog</u>. This will open the '''''ChangeLog''''' sub-menu.

[[Image:Linuxtools-ChangeLogPreferences.png]]

The screenshot above displays the preferences associated with the ChangeLog plug-in. These preferences are:

; Author Name : The name of the Author to be included in the ChangeLog entry.

; Author Email : The email address of the Author to be included in the ChangeLog entry.

; Formatter : The name of the formatter module Eclipse should use for ChangeLog entries. The form of each ChangeLog entry depends on which formatter module the ChangeLog plug-in uses. The ChangeLog plug-in provides a GNU-style formatter. There is an extension point by which other plug-ins may contribute alternate formatters.

; Editor : The name of the editor module Eclipse should use for editing the ChangeLog file.

= ChangeLog Editor =

The ChangeLog plug-in provides a special editor for ChangeLog files. This editor has syntax highlighting and provides a ''file-hyperlink'' feature. To use the ''file-hyperlink'' feature, hold the <code>'''Ctrl'''</code> key and click on any filename to open the corresponding file.

[[Image:Linuxtools-ChangeLog-editor.png]]

You can also copy all <code>''ChangeLog''</code> file changes (since the last check-in to the repository) to the clipboard. To do so, use the key combination <code>'''Ctrl'''</code>+<code>'''Alt'''</code>+<code>'''V'''</code>. This is useful if you wish to use the ChangeLog entry as your comment when you perform a commit.

= ChangeLog Plug-in Functions =

The ChangeLog plug-in has two functions: '''Insert ChangeLog''' and '''Prepare ChangeLog'''. 

The first time you invoke either function for a specific project, a '''''Folder Selection''''' menu will appear. This menu will allow you to select where to save the <code>''ChangeLog''</code> file for that project. 

[[Image:Screenshot-FolderSelection_changelogplugin.png]]

After selecting where to save the <code>''ChangeLog''</code> file, Eclipse will open it in your workspace editor. The ChangeLog plug-in will then generate an appropriate pre-compiled entry for you to edit further. You can close the <code>''ChangeLog''</code> file after saving it; when you invoke the '''Insert ChangeLog''' or '''Prepare ChangeLog''' function again, Eclipse will use the same <code>''ChangeLog''</code> file. 

The following sections describe both functions in more detail.

== Insert ChangeLog ==

This function generates a single ChangeLog entry for the currently selected file in the editor. To use this function, navigate to <u>Edit</u> > <u>ChangeLog Entry</u>. Alternatively, you can also use the key combination <code>'''Ctrl'''</code>+<code>'''Alt'''</code>+<code>'''C'''</code>.

[[Image:Linuxtools-ChangeLog-insert-changelog.png]]

Invoking the '''Insert ChangeLog''' function for another file in the same project will create a new ChangeLog entry for the file. If an entry already exists for a file, invoking the '''Insert ChangeLog''' function for that file will place the insertion point in the appropriate entry. 

== Prepare ChangeLog ==

This function generates a full ChangeLog entry based on the differences between the local changes you made to a project and its source control repository. As such, using this function requires access to the the source control repository of a project. 

The ChangeLog entry generated by the '''Prepare ChangeLog''' function will include new files, removed files, and modifications. To invoke this function, navigate to <u>Project</u> > <u>Prepare ChangeLog</u>. Alternatively, you can also use the key combination <code>'''Ctrl'''</code>+<code>'''Alt'''</code>+<code>'''P'''</code>.


[[Image:Linuxtools-ChangeLog-prepare-changelog-result.png]]

<p class="copyright">&#169; Copyright Red Hat, Inc. 2009
<br>&#169; Copyright Phil Muldoon <pkmuldoon@picobot.org> 2006.
<br>This documentation is licensed under the Eclipse Public License v. 1.0.</p>

Return to Linux Tools Project/ChangeLog/User Guide.

Retrieved from "http://wiki.eclipse.org/Linux_Tools_Project/ChangeLog/User_Guide"

Home Privacy Policy Terms of Use Copyright Agent Contact About Eclipsepedia	Copyright © 2009 The Eclipse Foundation. All Rights Reserved

Eclipse

View source

From Eclipsepedia

Personal tools