From c12a9d7f41682491b16e79fc4f436c72518eed19 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Mon, 28 Sep 2015 00:59:01 +0200 Subject: [PATCH] Update documentation for 4.1 Change-Id: Ib99e39c12b09b2731faef591d323542b89b583ba Signed-off-by: Matthias Sohn --- org.eclipse.egit.doc/build-help.xml | 4 +- .../help/EGit/Contributor_Guide/Bugs.html | 27 ++++-- .../help/EGit/Contributor_Guide/Builds.html | 7 +- .../Development-IDE-Configuration.html | 8 +- .../Git-For-Eclipse-Users.html | 4 +- .../help/EGit/New_and_Noteworthy/4.0/4.0.html | 93 ------------------ .../help/EGit/New_and_Noteworthy/4.1/4.1.html | 95 +++++++++++++++++++ .../New_and_Noteworthy/{4.0 => 4.1}/Bug-Fixes.html | 16 ++-- .../{4.0 => 4.1}/Contributors.html | 35 +++---- .../{4.0 => 4.1}/Updating-This-Document.html | 8 +- .../help/EGit/User_Guide/Tasks.html | 19 +++- .../help/EGit/User_Guide/User-Guide.html | 2 +- ...it-4.0-git_flow-repository_node_right_click.png | Bin 0 -> 529 bytes ...0-git_flow_init-repository_node_right_click.png | Bin 0 -> 503 bytes ...tart_release_from_history_view_context_menu.png | Bin 0 -> 1927 bytes ...it_flow_submenu-repository_node_right_click.png | Bin 0 -> 2357 bytes .../help/JGit/New_and_Noteworthy/4.0/4.0.html | 105 --------------------- .../help/JGit/New_and_Noteworthy/4.1/4.1.html | 79 ++++++++++++++++ .../New_and_Noteworthy/{4.0 => 4.1}/Bug-Fixes.html | 16 ++-- .../{4.0 => 4.1}/Contributors.html | 24 ++--- .../{4.0 => 4.1}/Updating-This-Document.html | 8 +- org.eclipse.egit.doc/help/toc.xml | 54 ++++++----- 22 files changed, 305 insertions(+), 299 deletions(-) delete mode 100644 org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/4.0.html create mode 100644 org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/4.1.html rename org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/{4.0 => 4.1}/Bug-Fixes.html (78%) rename org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/{4.0 => 4.1}/Contributors.html (81%) rename org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/{4.0 => 4.1}/Updating-This-Document.html (87%) create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Egit-4.0-git_flow-repository_node_right_click.png create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Egit-4.0-git_flow_init-repository_node_right_click.png create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Egit-4.0-git_flow_start_release_from_history_view_context_menu.png create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Egit-4.0-git_flow_submenu-repository_node_right_click.png delete mode 100644 org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.0/4.0.html create mode 100644 org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.1/4.1.html rename org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/{4.0 => 4.1}/Bug-Fixes.html (78%) rename org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/{4.0 => 4.1}/Contributors.html (83%) rename org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/{4.0 => 4.1}/Updating-This-Document.html (87%) diff --git a/org.eclipse.egit.doc/build-help.xml b/org.eclipse.egit.doc/build-help.xml index e480f4518..2e889e1da 100644 --- a/org.eclipse.egit.doc/build-help.xml +++ b/org.eclipse.egit.doc/build-help.xml @@ -47,8 +47,8 @@ > - - + + diff --git a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Bugs.html b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Bugs.html index 7877a825e..d6cfb9e2c 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Bugs.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Bugs.html @@ -39,12 +39,27 @@

Filing Bugs

-

- File a bug for EGit -

-

- File a bug for JGit -

+

How to file bugs

+ +

File a bug

+ diff --git a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Builds.html b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Builds.html index c63a36cbb..6d07ef215 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Builds.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Builds.html @@ -136,11 +136,10 @@

Checking for JGit API Changes using API Baseline

The JGit projects have API tooling enabled. In order to use PDE API tools to get assistance with maintaining API changes and additions you need to set an API baseline:

    -
  • download the p2 repository for the latest EGit release (which includes the JGit artifacts) to a local folder, e.g. ~/egit-releases/updates-3.0, find the p2 repository URLs - here and see - mirroring artifacts for a way to download the repository +
  • download the p2 repository for the latest EGit release (which includes the JGit artifacts) to a local folder, e.g. ~/egit-releases/updates-4.0, find the p2 repository URLs + here and download the p2 repository of the latest minor release (service releases don't change API) using the corresponding link in the last column of that table
  • -
  • in Eclipse click "Preferences > Plug-In Development > API Baselines", click "Add Baseline..." and define a new baseline (e.g. egit-3.0) and point it to the local copy of the corresponding EGit p2 repository.
  • +
  • in Eclipse click "Preferences > Plug-In Development > API Baselines", click "Add Baseline..." and define a new baseline (e.g. egit-4.0) and point it to the local copy of the corresponding EGit p2 repository.
  • the API tools will then raise warning/errors for all detected problems and provide quick fixes helping to resolve these problems
  • see the PDE API Tools User Guide for more details. diff --git a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Development-IDE-Configuration.html b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Development-IDE-Configuration.html index 82f48a612..07512de75 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Development-IDE-Configuration.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Development-IDE-Configuration.html @@ -30,7 +30,7 @@

Development IDE Configuration

-

Download and install "Eclipse for RCP and RAP Developers" from here, if you don't already have it:

+

Download and install the Eclipse package "Eclipse IDE for Eclipse Committers" or "Eclipse for RCP and RAP Developers" from here, if you don't already have it:

http://www.eclipse.org/downloads/

@@ -71,7 +71,7 @@

Dependencies

After importing the EGit and JGit projects in Eclipse, they will not compile due to missing dependencies. There are a few ways to install these.

-

Option 1: Use a Target Platform

+

Option 1 (recommended): Use a Target Platform

EGit target platforms in org.eclipse.egit.target

@@ -81,10 +81,10 @@ org.eclipse.egit.target project
  • Choose the - egit-<version>.target file matching the version of your Eclipse platform (e.g. 4.2 for Juno) and open it (this may take a while as it downloads the indexes of the p2 repositories the target platform refers to) + egit-<version>.target file matching the version of your Eclipse platform (e.g. 4.5 for Mars) and open it (this may take a while as it downloads the indexes of the p2 repositories the target platform refers to)
  • In the resulting editor, click on the - Set as Target Platform link at the top right (this may also take a while) + Set as Target Platform link at the top right (this may also take a while since it downloads the dependencies)
  • After that, the workspace should build cleanly. If not, try Project > Clean... > All. If this also doesn't help open Preferences > Plug-In Development > Target Platform, diff --git a/org.eclipse.egit.doc/help/EGit/Git_For_Eclipse_Users/Git-For-Eclipse-Users.html b/org.eclipse.egit.doc/help/EGit/Git_For_Eclipse_Users/Git-For-Eclipse-Users.html index 65cde4fda..05ce6d160 100644 --- a/org.eclipse.egit.doc/help/EGit/Git_For_Eclipse_Users/Git-For-Eclipse-Users.html +++ b/org.eclipse.egit.doc/help/EGit/Git_For_Eclipse_Users/Git-For-Eclipse-Users.html @@ -428,7 +428,7 @@ Unpacking objects: 100% (5/5), done. To /tmp/other * branch french -> french * branch web -> web -$ cd /tmp/other # Switch to 'other' repository +$ cd /tmp/other # Switch to 'other' repository. git commands now apply to this repository $ git config --bool core.bare false # need to allow this repository to have checked out files $ ls # Nothing to be seen, but it's there $ git branch @@ -442,7 +442,7 @@ $ echo '<h1>Git rocks!</h1>' >> index.html $ git commit -a -m "Added Git Rocks!" 510621a Added Git Rocks 1 files changed, 1 insertions(+), 0 deletions(-) -$ cd /tmp/example # Back to first repo +$ cd /tmp/example # Back to first repo. git commands now apply to 'example' repository $ git pull other web # Pull changes from 'other' repo 'web' branch remote: Counting objects: 5, done. remote: Compressing objects: 100% (3/3), done. diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/4.0.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/4.0.html deleted file mode 100644 index 9a4b0dc22..000000000 --- a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/4.0.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - EGit 4.0 New and Noteworthy - - - - - - - - - - - - - - - - - -


    -

    EGit

    -

    Features

    -
      -
    • Extend EGit to support git-flow - 1 to automate git branching workflow -
    • -
    • Introduce internal API to integrate Team merging to prepare support for model merge
    • -
    • Wizard for invoking automated project import
    • -
    • Prevent Git Staging view to lose data when precommit hook aborts commit
    • -
    • Show message dialog when hook aborts commit
    • -
    • Java templates variables for Git config variables
    • -
    -

    - 1 - http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/ -

    -

    Usability Improvements

    -
      -
    • Sort branches in "Push to Gerrit" wizard case insensitive
    • -
    • Automatic wildcard matching in "Add Git repositories" dialog
    • -
    • Make PushResultDialog non-modal
    • -
    • Properly style PushResultDialog in dark theme
    • -
    • Fix styling of staging view and commit dialog for dark theme
    • -
    • Add interactive rebase tooltip descriptions
    • -
    • Raise warning if second line of commit message isn't empty
    • -
    • Add sash to PushResultTable to allow resizing text field used to display push message
    • -
    • Avoid blinking cursor in merge result dialog
    • -
    • Accept git clone command as URI in clone wizard
    • -
    • Close commit editor after deleting stash
    • -
    • Consider different users and repo suffixes in project import
    • -
    • Make welcome page contribution more consistent
    • -
    -

    Performance Improvements

    -
      -
    • Use image descriptors cache for external programs
    • -
    • Optimizations for GitResourceDeltaVisitor visit()
    • -
    • Fix ResourceUtil performance on big repositories/workspaces
    • -
    • Allow to switch the branch sequence off in the commit message viewer
    • -
    -

    Build and release engineering

    -
      -
    • Update minimum required Java version to Java 7
    • -
    • Update build to use eclipse-jarsigner-plugin 1.1.2
    • -
    • Update to Jetty 9.2.10
    • -
    • Update to javax.servlet 3.1
    • -
    • Oomph configuration to setup Eclipse for EGit contributors
    • -
    • Update build to use Tycho 0.23.0
    • -

    - - - - - - - - - - - - - - \ No newline at end of file diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/4.1.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/4.1.html new file mode 100644 index 000000000..f406f8a26 --- /dev/null +++ b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/4.1.html @@ -0,0 +1,95 @@ + + + + + EGit 4.1 New and Noteworthy + + + + + + + + + + + + + + + + + +
    +

    EGit

    +

    Merge Strategy Extension Point

    +

    Introduce a merge strategy extension point which allows to plugin custom merge strategies. This will be used by EMF Compare to add support for merging models.

    +

    Staging View and Commit Dialog

    +
      +
    • Add check for build warnings and errors before commit. Optionally block commit if there are any problems reported
    • +
    • Make warning for non-empty second line of commit message optional
    • +
    • Consider initial selection in Staging View
    • +
    • Improve Staging View to remember position of its components
    • +
    • Introduce compare mode for Git Staging View similar to History View
    • +
    +

    History View

    +
      +
    • Rewrite CommitMessageViewer to use JFace
    • +
    • Simplify hyperlink syntax coloring
    • +
    • Use standard hyperlink link colors
    • +
    +

    Repositories View

    +
      +
    • Decorate repository in Repositories View if working tree is dirty
    • +
    • Use decoration color to render dirty decorator in repositories view
    • +
    • Improve sorting of nodes in Repositories View
    • +
    +

    Other Enhancements

    +
      +
    • Auto-configure Gerrit after ssh clone
    • +
    • Add "Compare with/Replace with" actions to ResourceMappings
    • +
    • Use the default repository folder when importing Team project sets
    • +
    • Consider initial selection in Interactive Rebase view
    • +
    +

    Gitflow Support

    +
      +
    • Allow changing branch names when initializing a Gitflow repository
    • +
    • Add icon decorations to identify gitflow repositories
    • +
    • Allow changing the commit message during feature finish with squash option
    • +
    • Implement squash and keep branch options for feature finish
    • +
    +

    Performance Improvements

    +
      +
    • Do not iterate over all staged view entries if not needed
    • +
    • Add default limit for number of shown diff lines in history
    • +
    +

    Release Engineering and Build

    +
      +
    • Update swtbot to 2.3.0
    • +
    • Update org.apache.httpcomponents used by JGit to 4.3
    • +
    • Stabilize unstable UI tests
    • +
    • Add Gitflow UI tests
    • +
    • Enable NPE analysis in EGit
    • +

    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/Bug-Fixes.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/Bug-Fixes.html similarity index 78% rename from org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/Bug-Fixes.html rename to org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/Bug-Fixes.html index a473c9da3..5acbf4afa 100644 --- a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/Bug-Fixes.html +++ b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/Bug-Fixes.html @@ -2,7 +2,7 @@ - EGit 4.0 New and Noteworthy - Bug Fixes + EGit 4.1 New and Noteworthy - Bug Fixes @@ -12,7 +12,7 @@ - + Previous @@ -24,25 +24,25 @@ - EGit 4.0 New and Noteworthy + EGit 4.1 New and Noteworthy Contributors

    Bug Fixes

    - 40 Bugs and 5 enhancement requests were closed + 47 Bugs and 17 enhancement requests were closed


    - + diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/Contributors.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/Contributors.html similarity index 81% rename from org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/Contributors.html rename to org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/Contributors.html index ebd382e83..1a74fa323 100644 --- a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.0/Contributors.html +++ b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.1/Contributors.html @@ -2,7 +2,7 @@ - EGit 4.0 New and Noteworthy - Contributors + EGit 4.1 New and Noteworthy - Contributors @@ -30,28 +30,29 @@

    Contributors

    -

    The following 21 developers worked on this release:

    +

    The following 22 developers worked on this release:

    Andrey Loskutov, + Chris Price, Christian Georgi, - Christian Halstrick, - Chris Rebert, Dani Megert, - Erwin van Eyk, - Fabio Zadrozny, - Gunnar Wagenknecht, + Denis Zygann, + Jan-Ove Weichel, + Joachim Käßer, Jon Ander Peñalba, - Kyle J. Harms, + Karsten Panier, Lars Vogel, Laurent Delaigue, - Laurent Goubet, - Markus Keller, Matthias Sohn, + Markus Keller, Max Hohenegger, - Michael Mathews, - Michael Keppler, - Mickael Istria, - Radim Hopp, - rnveach


    + Mykola Nikishov, + Pawel Nowak, + Peter Karena, + Philipp Bumann, + Stefan Dirix, + Thomas Wolf, + Tobias Baumann, + Wayne Beaton


    @@ -24,25 +24,25 @@ - +

    Bug Fixes

    - 10 Bugs and 1 enhancement requests were closed + 11 Bugs and 3 enhancement requests were closed


    - + diff --git a/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.0/Contributors.html b/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.1/Contributors.html similarity index 83% rename from org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.0/Contributors.html rename to org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.1/Contributors.html index 882a9cad0..aca519c55 100644 --- a/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.0/Contributors.html +++ b/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.1/Contributors.html @@ -2,7 +2,7 @@ - JGit 4.0 New and Noteworthy - Contributors + JGit 4.1 New and Noteworthy - Contributors @@ -30,26 +30,22 @@

    Contributors

    -

    The following 20 developers worked on this release of JGit :

    +

    The following 16 developers worked on this release of JGit :

    Andrey Loskutov, - André de Oliveira, + Chris Price, Christian Halstrick, Dave Borowitz, - David Ostrovsky, David Pletcher, - Hector Oswaldo Caballero, + Fredrik Medley, Hugo Arès, + Jacob Keller, Jonathan Nieder, - Kaloyan Raev, - Laurent Delaigue, - Markus Duft, - Matthew Spurrier, + Martin Fick, Matthias Sohn, - Saša Živkov, - Sebastian Schuberth, + Patrick Steinhardt, Shawn Pearce, - Stefan Beller, Terry Parker, + Tobias Oberlies, Yuxuan 'fishy' Wang


    @@ -59,8 +55,8 @@