From 2e24f53c6260449db876841a6ffa88104f72278c Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Fri, 23 Dec 2016 23:23:08 +0100 Subject: [PATCH] Update documentation for 4.6 Change-Id: Ibbc123eff53f4096c84c1f044e314b18652bf814 Signed-off-by: Matthias Sohn --- org.eclipse.egit.doc/build-help.xml | 4 +- .../help/EGit/Contributor_Guide/Bugs.html | 5 ++ .../help/EGit/Contributor_Guide/Builds.html | 48 +++++++++-- .../Contributor_Guide/Contributing-Patches.html | 2 +- .../Contributor_Guide/Manual-Developer-Setup.html | 6 +- .../help/EGit/New_and_Noteworthy/4.5/4.5.html | 80 ------------------ .../help/EGit/New_and_Noteworthy/4.6/4.6.html | 93 +++++++++++++++++++++ .../New_and_Noteworthy/{4.5 => 4.6}/Bug-Fixes.html | 16 ++-- .../{4.5 => 4.6}/Contributors.html | 23 +++-- .../{4.5 => 4.6}/Updating-This-Document.html | 8 +- .../help/EGit/User_Guide/Reference.html | 4 +- .../help/EGit/User_Guide/Tasks.html | 19 +++-- .../images/Commit-editor-commit-page-egit-4.6.png | Bin 0 -> 75793 bytes .../images/Commit-editor-diff-page-egit-4.6.png | Bin 0 -> 101348 bytes .../images/Commit-editor-notes-page-egit-4.6.png | Bin 0 -> 50141 bytes .../help/JGit/New_and_Noteworthy/4.5/4.5.html | 92 -------------------- .../help/JGit/New_and_Noteworthy/4.6/4.6.html | 79 +++++++++++++++++ .../New_and_Noteworthy/{4.5 => 4.6}/Bug-Fixes.html | 16 ++-- .../{4.5 => 4.6}/Contributors.html | 50 +++++------ .../{4.5 => 4.6}/Updating-This-Document.html | 8 +- org.eclipse.egit.doc/help/toc.xml | 39 +++++---- 21 files changed, 321 insertions(+), 271 deletions(-) delete mode 100644 org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/4.5.html create mode 100644 org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/4.6.html rename org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/{4.5 => 4.6}/Bug-Fixes.html (80%) rename org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/{4.5 => 4.6}/Contributors.html (82%) rename org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/{4.5 => 4.6}/Updating-This-Document.html (88%) create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Commit-editor-commit-page-egit-4.6.png create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Commit-editor-diff-page-egit-4.6.png create mode 100644 org.eclipse.egit.doc/help/EGit/User_Guide/images/Commit-editor-notes-page-egit-4.6.png delete mode 100644 org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.5/4.5.html create mode 100644 org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.6/4.6.html rename org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/{4.5 => 4.6}/Bug-Fixes.html (78%) rename org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/{4.5 => 4.6}/Contributors.html (74%) rename org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/{4.5 => 4.6}/Updating-This-Document.html (88%) diff --git a/org.eclipse.egit.doc/build-help.xml b/org.eclipse.egit.doc/build-help.xml index 60948e3d7..8e2b28934 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 1e47bdda9..3224d1291 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Bugs.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Bugs.html @@ -247,6 +247,11 @@


+

+

Spam Bugs

+

If you come across spam bugs you can request webmaster to delete them by marking them as duplicate of bug 442999.

+

Also see + bug 502814

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 300d089f4..3712a5175 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Builds.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Builds.html @@ -36,7 +36,7 @@

Prerequisites for the Maven build are

  • - at least Maven 3.0.0 (but currently not Maven 3.1.0) + at least Maven 3.0.0
  • see settings.xml reference on how to do basic Maven configuration @@ -57,7 +57,7 @@

    JGit

    • JGit can be built using Maven 2 or 3.
    • -
    • use Java 7 to run the JGit Maven build
    • +
    • use Java 8 to run the JGit Maven build
    • JGit packaging projects (Eclipse feature and update site) are built using Maven 3 and Tycho.

    EGit

    @@ -108,13 +108,49 @@
    [~/src/egit] $ mvn clean install -Djgit-site=https://repo.eclipse.org/content/unzip/snapshots.unzip/
                          org/eclipse/jgit/org.eclipse.jgit.repository/${JGIT_VERSION}/org.eclipse.jgit.repository-${JGIT_VERSION}.zip-unzip/
     
    -

    If you wan to build EGit for the specific Juno platform, consider using the platform-juno maven profile:

    -
    [~/src/egit] $ mvn -P platform-juno clean install
    +		

    If you wan to build EGit for the specific Neon (4.6) platform, consider using the egit-4.6 target platform:

    +
    [~/src/egit] $ mvn -Dtarget-platform=egit-4.6 clean install
     
    -

    For EGit version 3.0, platform-juno (Eclipse 4.2) and platform-kepler (Eclipse 4.3) are available. In addition platform-kepler-staging refers to the Kepler staging repository.

    +

    For EGit version 4.6, egit-4.5 (Mars, Eclipse 4.5), egit-4.6 (Neon, Eclipse 4.6), and egit-4.7 (Oxygen, Eclipse 4.7) are available. In addition egit-4.7-staging refers to the Oxygen staging repository.

    Upon a successful build, a p2 update site should be generated inside - egit/org.eclipse.egit.repository/target/repository. If not, make sure the target platform has been downloaded from within Eclipse (Windows>Preferences>Plug-in Development>Target Platform). The default target platform defined in the maven build is currently Eclipse 4.3. + egit/org.eclipse.egit.repository/target/repository. If not, make sure the target platform has been downloaded from within Eclipse (Windows>Preferences>Plug-in Development>Target Platform). The default target platform defined in the maven build is currently Eclipse 4.6. If you skip setting the system property target-platform the target platform for Eclipse 4.6 will be used.

    +

    JGit Buck Build

    +

    The JGit libraries used by Gerrit Code Review can also be built using + buck: +

    + +
    [jgit] $ buck build all
    +
    +
      +
    • to run the unit tests run
    • +
    +
    [jgit] $ buck test
    +
    +

    JGit Bazel Build

    +

    Since Gerrit is migrating its build from buck to + Bazel a + Bazel build for JGit is under construction. +

    +

    You can try the Bazel build:

    +
      +
    • + install Bazel +
    • +
    • fetch the change implementing the Bazel build
    • +
    +
    [jgit] $ git fetch https://git.eclipse.org/r/a/jgit/jgit refs/changes/27/84527/8 && git checkout FETCH_HEAD
    +
    +
      +
    • to build all libraries run
    • +
    +
    [jgit] $ bazel build :all
    +

    FindBugs and PMD

    As part of the build, JGit and EGit run FindBugs and PMD to find issues.

      diff --git a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Contributing-Patches.html b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Contributing-Patches.html index 4872b079b..76259eede 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Contributing-Patches.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Contributing-Patches.html @@ -369,7 +369,7 @@ Copyright (C) YEAR Your Name <you@example.org>

      • Run all existing tests. It does not take very long.
      • -
      • Pay attention to the Java and Eclipse SDK baselines. EGit requires only Java 7 and Eclipse 3.8.2. You cannot use API's that are newer.
      • +
      • Pay attention to the Java and Eclipse SDK baselines. EGit requires only Java 8 and Eclipse 4.4. You cannot use API's that are newer.

      Sending patches by mail

      Although sending patches by mail is the approved way of interacting with, and asking feedback from, the Git project, please don't send patches via diff --git a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Manual-Developer-Setup.html b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Manual-Developer-Setup.html index 6368eb209..6e4b20647 100644 --- a/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Manual-Developer-Setup.html +++ b/org.eclipse.egit.doc/help/EGit/Contributor_Guide/Manual-Developer-Setup.html @@ -118,13 +118,13 @@ git clone <enter URL>

    • Restart

    Java Requirements

    -

    EGit and JGit have Java 7.0 and - Eclipse Platform 3.8.2 (Juno) as minimum requirements, so dependencies to newer Java and platform versions must be avoided. +

    EGit and JGit have Java 8.0 and + Eclipse Platform 4.4 (Luna) as minimum requirements, so dependencies to newer Java and platform versions must be avoided.

    We are using API Tools Environment Descriptions (see changes for JGit and - EGit) to facilitate detecting code which isn't working on Java 7. If you followed the instructions in the + EGit) to facilitate detecting code which isn't working on Java 8. If you followed the instructions in the Tools section above, the necessary descriptions should already be installed. Otherwise install API Tools Environment Descriptions from the release train repository, see Installing Execution Environment Descriptions. diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/4.5.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/4.5.html deleted file mode 100644 index 82ae9adc0..000000000 --- a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/4.5.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - EGit 4.5 New and Noteworthy - - - -

- - - - - - - - - - - - - - -

EGit

-

Features

-
    -
  • Staging view: Fix expansion problems and provide auto selection support.
  • -
  • Check for running launches before modifying the workspace before checkout, pull, rebase, interactive rebase, merge, reset --hard, replace with, cherry-pick
  • -
  • GitHistoryPage: move the search widget into the toolbar
  • -
  • Auto-stage selected files on "Commit..." when staging view is used
  • -
  • Added context menu support for nested repositories.
  • -
  • Immediate user feedback on failed push background jobs
  • -
  • Push to Gerrit in a background job
  • -
  • Allow to cancel the deletion of branches operation
  • -
  • Avoid opening dialogs from push/fetch background jobs
  • -
  • Recompute index diff (git status) on project deletions
  • -
  • Polish the UI of the rebase interactive view
  • -
  • Open the smart import wizard if available (Eclipse 4.6 or higher).
  • -
  • Keyboard shortcuts for the rebase interactive view
  • -
  • Do not show "Rebase was aborted" dialog if the user pressed abort
  • -
  • [blame] Don’t open the History view automatically when showing annotations
  • -
  • Suppress bare repositories in RepositorySearchDialog
  • -
  • Make columns in Gitflow feature checkout dialog sortable
  • -
-

Performance

-
    -
  • Speed up the IgnoreOperation
  • -
  • Speed up context menu in staging view
  • -
  • More efficient label provider for the staging view
  • -
  • Improve performance of StagingView a little
  • -
-

Releng

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

EGit

+

Features

+
    +
  • Add hyperlinks to unified Diff Viewer to enable opening
  • +
  • Open the previous version in an editor
  • +
  • Open the workspace version (if it exists) in an editor
  • +
  • Open "this" version (i.e., the “current” one of the diff) in an editor
  • +
  • Open a two-way diff between the previous and this version in a compare editor
  • +
  • Turn the DiffEditorPage used to display unified diffs into a real TextEditor. This enables many standard text editor actions like "Find" or "Go to line".
  • +
  • Add an outline view for the diff tab of the Commit Viewer and enable text editor toolbar items
  • +
  • Handle rebase modes 'preserve' and 'interactive' in EGit
  • +
  • Introduce GitSynchronizer for logical model support
  • +
  • Make auto-staging of files being moved configurable
  • +
  • Make auto-staging of files being deleted configurable
  • +
  • Compare/ReplaceWithPrevious support for multiple resources (in mappings)
  • +
+

Usability Improvements

+
    +
  • Show accurate progress reports for pull
  • +
  • Use "Revision Information" label in preferences and update job
  • +
  • Hide warning when reconfiguring upstream from local to remote branch
  • +
  • Suppress the "Interactive rebase has been prepared" dialog
  • +
  • Give focus to commit message when auto-staging is enabled
  • +
  • More configurable date formatting
  • +
  • Improve listing in "Report Bug or Enhancement" dialog
  • +
  • Use "Show Revision Information" instead of "Show Annotations"
  • +
  • Save and restore previously selected reset type
  • +
  • Show Git Staging view in Git Repositories view's Show In menu
  • +
  • Improve search implementation in RepositorySearchDialog
  • +
+

Performance Improvements

+
    +
  • Fix that click on search result caused EGit to stat the repository directory
  • +
+

Build and Release Engineering

+
    +
  • Change EGit minimum execution environment to JavaSE-1.8
  • +
  • Change EGit Github Client's minimum execution environment to JavaSE-1.8
  • +
  • Add Oxygen target platform, remove target platforms older than Mars
  • +
  • Automatic Oomph Developer Setup +
      +
    • Add branding
    • +
    • Activate Change-Id
    • +
    • Update Oomph egit setup
    • +
    • Enforce UTF8 encoding of workspace
    • +
    +
  • +
+ + + + + + + + + + + + + + \ No newline at end of file diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/Bug-Fixes.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/Bug-Fixes.html similarity index 80% rename from org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/Bug-Fixes.html rename to org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/Bug-Fixes.html index 259466ab4..80ffb9109 100644 --- a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/Bug-Fixes.html +++ b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/Bug-Fixes.html @@ -2,7 +2,7 @@ - EGit 4.5 New and Noteworthy - Bug Fixes + EGit 4.6 New and Noteworthy - Bug Fixes @@ -12,7 +12,7 @@ - + Previous @@ -24,25 +24,25 @@ - EGit 4.5 New and Noteworthy + EGit 4.6 New and Noteworthy Contributors

Bug Fixes

- 32 Bugs and 5 enhancement requests were closed + 32 Bugs and 5 enhancement requests were closed

- + diff --git a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/Contributors.html b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/Contributors.html similarity index 82% rename from org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/Contributors.html rename to org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/Contributors.html index eb3abf0cf..fd7832abc 100644 --- a/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.5/Contributors.html +++ b/org.eclipse.egit.doc/help/EGit/New_and_Noteworthy/4.6/Contributors.html @@ -2,7 +2,7 @@ - EGit 4.5 New and Noteworthy - Contributors + EGit 4.6 New and Noteworthy - Contributors @@ -30,23 +30,20 @@

Contributors

-

The following 16 developers worked on this release:

-

Andre Bossert, - Andrey Loskutov, - Brandon Dong, - Christian Halstrick, - David Pursehouse, - Ed Merks, +

The following 13 developers worked on this release:

+

Andrey Loskutov, + Andrey Rodionov, + Dani Megert, + Gunnar Wagenknecht, Lars Vogel, Laurent Delaigue, Marc-Andre Laperle, Matthias Sohn, Max Hohenegger, Michael Keppler, - Stephen Elsemore, + Stefan Dirix, Thomas Wolf, - Tobias Baumann, - Tobias Hein

+ Tomasz Zarna

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

Bug Fixes

- 9 Bugs were closed + 2 enhancement requests and 3 bugs were closed

- + diff --git a/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.5/Contributors.html b/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.6/Contributors.html similarity index 74% rename from org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.5/Contributors.html rename to org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.6/Contributors.html index 6174494f3..2381ec370 100644 --- a/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.5/Contributors.html +++ b/org.eclipse.egit.doc/help/JGit/New_and_Noteworthy/4.6/Contributors.html @@ -2,7 +2,7 @@ - JGit 4.5 New and Noteworthy - Contributors + JGit 4.6 New and Noteworthy - Contributors @@ -30,30 +30,26 @@

Contributors

-

The following 23 developers worked on this release of JGit :

-

Andrey Loskutov, - Christian Halstrick, - Christian Pontesegger, - Dave Borowitz, - Dan Wang, - David Pursehouse, - Hugo Arès, - Jens Offenbach, - Jonathan Nieder, - Marco Miller, - Mark Ingram, - Markus Keller, - Martin Goellnitz, - Masaya Suzuki, - Matthaus Owens, - Matthias Sohn, - Michael Keppler, - Mike Williams, - Ned Twigg, - Shawn Pearce, - Stefan Beller, - Terry Parker, - Thomas Wolf

+

The following 19 developers worked on this release of JGit :

+

Christian Halstrick + Dave Borowitz + David Pursehouse + David Turner + Grace Wang + Hugo Arès + Jacek Centkowski + Jonathan Nieder + Kevin Corcoran + Marc Strapetz + Masaya Suzuki + Matthias Sohn + Ned Twigg + Philipp Marx + Rüdiger Herrmann + Shawn Pearce + Thomas Meyer + Thomas Wolf + Zhen Chen