From 77510cbeb4250db80a9ed0ef5dfebbc6106e9293 Mon Sep 17 00:00:00 2001 From: Martin Oberhuber < martin.oberhuber@windriver.com> Date: Sat, 19 Aug 2006 03:48:34 +0000 Subject: [PATCH] Update Build Notes to refer to new user docs --- .../template/buildNotes.php | 155 ++++-------------- 1 file changed, 28 insertions(+), 127 deletions(-) diff --git a/releng/org.eclipse.rse.build/template/buildNotes.php b/releng/org.eclipse.rse.build/template/buildNotes.php index 924686838c7..0252cf13ca9 100755 --- a/releng/org.eclipse.rse.build/template/buildNotes.php +++ b/releng/org.eclipse.rse.build/template/buildNotes.php @@ -44,13 +44,10 @@ RSE quality to improve more and more as we are approaching our 1.0 release.
  • Numerous bugs have been fixed, and we consider RSE safe now for all kinds of data transfer, even if it's done in multiple background sessions - (except FTP, which will be enhanced as soon as the Jakarta Commons Net library + (except FTP, which will be enhanced as soon as the Jakarta Commons Net library passes EMO legal review).
    • -
  • See also the - - last milestone's New and Noteworthy.
  • Use - this query to show the list of bugs fixed since + this query to show the list of bugs fixed since the last milestone, RSE 1.0M3.
  • Look @@ -71,136 +68,41 @@
    -

    The simplest way to get RSE is via the Update Manager: From your running instance -of Eclipse 3.2, choose Help > Software Updates > Find and Install.... -Choose "Search for New Features to Install", and add a new Remote Site named -"RSE" and pointing to http://download.eclipse.org/dsdp/tm/updates/. -Select the RSE SDK feature, and perform the update process as usual.

    -

    If you prefer manual installation, you can download RSE SDK and either -

    • Extract it into your installation of Eclipse 3.2, or
      • -
    • Extract it into an empty directory and link it as product extension via Help > Install/Update, or
      • -
    • (If you want to write code for RSE) extract it into an empty directory, and from an Eclipse PDE Workspace - choose Import > Plug-in development > Plug-ins and Fragemtns. Select the RSE directory and import - everything.
      • -
    -Start Eclipse Workbench, and choose Window > Open Perspective > Other > Remote System Explorer.

    - -

    Even without an actual connection to a remote system, you can start experimenting with the RSE UI on the -local host, which is shown by default: -

      -
    • Browse the Filesystem, choose contextmenu > show in Table, and observe the Properties view
      • -
    • Create a new Filter to show specific resources in the file system only -
    • Launch an RSE Shell (Shells node > Launch) -
      • In the Shell, perform commands such as ls, dir, ps, gcc, make and see the output interpreted
        • -
      • Use Ctrl+Space Content Assist on the shell command entry field
        • -
      • -
    -For operations on an actual remote system, you can either -
      -
    • use the "SSH Only" system type (New > Other > Remote Systems Explorer > Connection), or
      • -
    • start a dstore server daemon on the remote system and use any of the other connection types.
      • -
    +

    The RSE User Documentation now has a + +Getting Started Tutorial that guides you through installation, first steps, +connection setup and important tasks.

    + API Freeze
    - Installing the Dstore server
    -

    -RSE is a framework that supports plugging in many different communication protocols. -By default, the dstore, FTP and ssh protocol plug-ins are provided, with dstore being -the richest in features.

    -

    -Dstore requirs a server to run on the remote system. There are several methods to -get a server launched for a particular user, the most easy one to set up is the -daemon method. To start a dstore launcher daemon, +

    As per the Target Management +plan, +we reached API Freeze for RSE M4.

    +

    In fact we have reviewed and documented all relevant APIs, but just like most +Eclipse projects, we'll still reserve the right to make API improvements when +committers vote on them. Votes will be held publicly, such that everyone will +be informed in case the APIs should change.

    +

    Currently, we see the following areas for potential API changes:

      -
    • On Windows:
        -
      • Extract the rseserver-*-windows.zip package and cd to it.
        • -
      • Run setup.bat, then run daemon.bat.
        • -
      • -
    • On Linux or AIX or other Unix:
        -
      • Extract the appropriate rseserver-*.tar package.
        • -
      • Become root and cd to the package directory.
        • -
      • Make sure that a Sun or IBM JRE 1.4 or higher is in the PATH. The gcj-based java installation - that comes with many Linux distributions will not do! You can download a Sun JRE from - http://java.sun.com. -
      • Run perl daemon.pl. -
      • +
    • Classes and Interfaces that are not meant for public use will be + moved to packages tagged as internal. This will apply + particularly to the "implementation" plugins for the ssh, ftp and + local subsystems (these do not define any new APIs anyways).
      • +
    • The IConnectorService interface may be slightly modified + in order to allow for better UI / Non-UI separation.
      • +
    • Some RSE Model classes may be moved from the UI plugin to the + non-UI core plugin.
    -

    -Note: In its default configuration for testing, the dstore daemon accepts unencrypted -passwords from the RSE client. For production use, SSL can be enabled in order to encrypt -connections, or the RSE server can be launched differently (e.g. through ssh).

    -

    -When no root access is available on the remote system (typically UNIX), normal -users can start a dstore server for themselves only, instead of a daemon: -

      -
    • On the remote system, run perl server.pl [portname]
      • -
    • On the RSE client, create the dstore connection
      • -
    • After creating the connection, select it and choose Properties -
      • On Server Launcher Settings, choose Connect to Running Server
        • -
      • On the Subsystem page, enter the port number you used for starting the server
        • -
      • -
    • When connecting, enter just anything for username and password (these will be ignored).
      • -
    • The server.pl script has more options, e.g. for using the first available - port instead of a well-known one, or for restricting access to a single - user ID. Since all dstore communication will be on the single TCP port, - this port can also be forwarded through an ssh tunnel if desired.
      • -
    - - - +If you want to start programming against RSE APIs now, best let us know +about your endeavours and keep yourself up-to-date.
    - - - - -
    - Using remote connections
    -
    -
      -
    • In the RSE Perspective, Remote Systems View, press the New Connection button.
        -
      • Note: In the Preferences, you can enable displaying available new connection types in the RSE tree.
      • -
    • Select the desired system type
        -
      • Coose system type "SSH Only" for ssh servers, or any other for dstore.
      • -
    • Enter an IP address for a remote system running an ssh server or dstore server. - A connection name will be suggested automatically, but can be changed.
        -
      • You can also run a dstore server on the local machine for testing. In this case, - type "localhost" as address.
        • -
      • You can press Finish right away, the wizard defaults are usually fine.
      • -
    • Fill in the username / password dialog.
        -
      • Note: For ssh, if you have private keys, the password here is just a dummy. - Enter anything and save it. You can setup ssh private key authentication through - the Team > CVS > SSH2 Connection Method Preference page.
      • -
    • Browse remote files, or open remote shells.
        -
      • You can drag and drop files between local and remote file systems, between editors and any view. - Files are transferred as needed.
        • -
      • On dstore, you can browse into remote archives (*.zip, *.tar) without having to transfer the entire contents. This works thanks - to "miners" on the remote side. Custom miners can be plugged into the dstore server.
        - Note: Some tar formats currently fail to work. See bug 139207.
        • -
      • On dstore, you can choose Search > Remote....
          -
        • The dstore miners support searching a remote file system - without having to transfer any data.
        • -
      • On dstore, when the remote system is Linux, AIX or Other Unix:
          -
        • Browse remote Processes.
          • -
        • Select "My Processes" and choose context menu > Monitor. -
        • Enable polling, choose a short wait time. See processes appear and vanish as you perform commands in a remote shell.
        • - -
      -
    - - -
    @@ -208,12 +110,11 @@ users can start a dstore server for themselves only, instead of a daemon:
    -The following M4 original plan deliverables did -not make it into this build: +The following M4 plan +deliverables did not make it into this build:
    • User Actions, and Import/Export were deferred with M3 already. - A new plan - has been published.
      • + A new plan has been published with M3 already.
    • JUnit tests did not make it into the build due to pending IP legal review. They are available from Bugzilla bug 149080