Changeset 6807 for trunk/doc/src/docbook


Ignore:
Timestamp:
Mar 26, 2015, 1:10:52 PM (8 years ago)
Author:
Nicklas Nordborg
Message:

References #1924, #1927 and #1325. Added information about incompatible changes and things to consider when updgrading to BASE 3.5.

Location:
trunk/doc/src/docbook
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/admin/installation.xml

    r6763 r6807  
    4747
    4848    <important id="installation.upgrade.important">
    49       <title>Important information for upgrading to the current release</title>
     49      <title>Important information for upgrading to BASE 3.5</title>
    5050      <para>
    5151        This section list some important information that may or may not
    … …  
    5656      </para>
    5757     
     58      <bridgehead>Biomaterial lists have been replaced with item lists</bridgehead>
     59      <para>
     60        This is a major change that has caused a binary compatibility in the BASE core
     61        API. If you depend on custom extensions or plug-ins that use the biomaterial list
     62        API this code must be updated before updating to BASE 3.5. Read more
     63        about the incompatibilities in <xref linkend="appendix.incompatible.itemlists" />.
     64      </para>
     65     
    5866      <bridgehead>Consider updating to Java 8</bridgehead>
    5967      <para>
    … …  
    6270        in the next version (BASE 3.6).
    6371      </para>
     72     
     73      <bridgehead>Consider updating to Tomcat 8</bridgehead>
     74      <para>
     75        We have now tested BASE with Tomcat 8 and it seems to work without
     76        any problems. Support for Tomcat 7 will be removed in the next
     77        version (BASE 3.6).
     78      </para>
     79     
    6480     
    6581    </important>
    … …  
    597613        <listitem>
    598614          <para>
    599             Download and install Apache Tomcat 7.0.30 or any later 7.x
    600             release, available from <ulink url="http://tomcat.apache.org" />.
     615            Download and install Apache Tomcat 8 (recommended) or
     616            Apache Tomcat 7 available from <ulink url="http://tomcat.apache.org" />.
    601617          </para>
    602618
    603619          <important>
    604620            <para>
    605               As of BASE 3.3 Tomcat 7 is required. BASE will no longer
    606               run on Tomcat 6 or lower.
     621              As of BASE 3.5, we are recommending Tomcat 8. Support for Tomcat
     622              7 will be removed in BASE 3.6.
    607623            </para>
    608624          </important>

  • trunk/doc/src/docbook/appendix/incompatible.xml

    r6480 r6807  
    3535    and backwards compatible.
    3636  </para>
     37 
     38  <sect1 id="appendix.incompatible.3.5">
     39    <title>BASE 3.5 release</title>
     40   
     41    <bridgehead id="appendix.incompatible.itemlists">Biomaterial lists has been replaced with item lists</bridgehead>
     42    <para>
     43      The <classname docapi="net.sf.basedb.core">BioMaterialList</classname>
     44      class has been removed and replaced with <classname
     45      docapi="net.sf.basedb.core">ItemList</classname>. The API is similar
     46      but not exactly the same. In most cases only minor changes are required
     47      to make existing code work with the new API.
     48    </para>
     49   
     50    <para>
     51      Queries that use the <code>BioMaterial.bioMaterialLists</code> association
     52      for joining will no longer work. There is no replacement functionality for
     53      joining item lists.
     54    </para>
     55   
     56    <para>
     57      All classes in the <code>net.sf.basedb.util.biomaterial</code> package has
     58      been deprecated. It is recommended that code that uses any of these classes
     59      are updated to use classes in <code>net.sf.basedb.util.listable</code> instead.
     60      The API is a bit different, but the new implementations typically performs a
     61      lot better so it is worth the work.
     62    </para>
     63
     64    <para>
     65      There are several other minor changes in the API that previously worked with
     66      the <code>BioMaterialList</code> class that has been removed and replaced
     67      with something else.
     68    </para>
     69   
     70  </sect1>
    3771 
    3872  <sect1 id="appendix.incompatible.3.4">

  • trunk/doc/src/docbook/appendix/update_warnings.xml

    r6600 r6807  
    3535    to the current version.
    3636  </para>
     37 
     38  <sect1 id="appendix.update_warnings.3.5">
     39    <title>BASE 3.5</title>
     40
     41    <bridgehead>Biomaterial lists have been replaced with item lists</bridgehead>
     42    <para>
     43      This is a major change that has caused a binary compatibility in the BASE core
     44      API. If you depend on custom extensions or plug-ins that use the biomaterial list
     45      API this code must be updated before updating to BASE 3.5. Read more
     46      about the incompatibilities in <xref linkend="appendix.incompatible.itemlists" />.
     47    </para>
     48   
     49    <bridgehead>Consider updating to Java 8</bridgehead>
     50    <para>
     51      Oracle is no longer supporting Java 1.7. We are recommending Java 8
     52      for running BASE. Java 7 is still supported, but will be removed
     53      in the next version (BASE 3.6).
     54    </para>
     55   
     56    <bridgehead>Consider updating to Tomcat 8</bridgehead>
     57    <para>
     58      We have now tested BASE with Tomcat 8 and it seems to work without
     59      any problems. Support for Tomcat 7 will be removed in the next
     60      version (BASE 3.6).
     61    </para>
     62   
     63  </sect1>
    3764 
    3865  <sect1 id="appendix.update_warnings.3.4">
Note: See TracChangeset for help on using the changeset viewer.