| 1 | {{{#!div style="float: right; margin: 0 1em" |
| 2 | ← [../1.2] | [../1.3.2] → |
| 3 | }}} |
| 4 | = Documenting API changes since 1.2.x |
| 5 | |
| 6 | {{{#!box info |
| 7 | The next stable version of Trac will be named 1.4 and will contain the cumulative changes made in the successive 1.2.x releases. |
| 8 | |
| 9 | These notes reflect the current status for [milestone:1.3.1], in [source:trunk]. |
| 10 | |
| 11 | Proposed changes are prefixed with an OPEN mark and the //paragraph is written in italics.// |
| 12 | }}} |
| 13 | |
| 14 | [[PageOutline(2-4,Summary,inline)]] |
| 15 | |
| 16 | |
| 17 | == Prerequisites |
| 18 | |
| 19 | **Only Python version 2.7 is supported.** |
| 20 | |
| 21 | The following language feature introduced in Python 2.6 can now be used and the related clean-ups can be done: |
| 22 | - TODO |
| 23 | |
| 24 | TODO: List supported browsers. Consider using [http://jquery.com/browser-support/ jQuery's list]. |
| 25 | |
| 26 | === Modified Dependencies |
| 27 | |
| 28 | See gmessage:trac-dev:nkMUY_8ILF0/rg1rsArDIewJ for a discussion about what dependencies we'll support in Trac 1.4. |
| 29 | |
| 30 | ==== jQuery and jQuery UI (bundled) |
| 31 | |
| 32 | ==== Babel (optional) |
| 33 | |
| 34 | ==== Genshi (mandatory) |
| 35 | |
| 36 | ==== Databases |
| 37 | |
| 38 | |||| **Database** || |
| 39 | || SQLite || >= 3.0 || |
| 40 | || PostgreSQL || >= 8.0 || |
| 41 | || MySQL / MariaDB || >= 5.0 || |
| 42 | |||| **Database Bindings** || |
| 43 | || pysqlite || >= 2.4.1 (version provided by Python 2.6), avoid 2.5.2 - 2.5.4 || |
| 44 | || psycopg2 || >= 2.0 || |
| 45 | || MySQLdb || >= 1.2.2 || |
| 46 | |
| 47 | ==== Other |
| 48 | |
| 49 | || Package || Req or Opt? || Version supported || |
| 50 | || SetupTools || Required || >= 0.6, 5.4 - 5.6 are not recommended. || |
| 51 | || Git || Optional || >= 1.5.6 || |
| 52 | || Subversion || Optional || >= 1.6 || |
| 53 | || !ConfigObj || Optional || Unspecified. Let's consider enforcing a minimum version, such as >= 5.0. !ConfigObj 5.0 released on [pypi:configobj/5.0.0 2014-02-15] || |
| 54 | || !DocUtils || Optional || >= 0.3.9 || |
| 55 | || Textile || Optional || >= 2.0 || |
| 56 | || Pygments || Optional || >= 0.6. Let's consider bumping the requirement to at least 1.0, released in [https://pypi.python.org/pypi/Pygments/1.0 2008] || |
| 57 | |
| 58 | ==== Compatible Distros |
| 59 | |
| 60 | The supported dependencies were determined by aiming to be compatible with the versions provided by the package managers on the following distros. |
| 61 | |
| 62 | || || **Ubuntu 14.04** || |
| 63 | || Babel || 1.3 || |
| 64 | || Genshi || 0.7 || |
| 65 | || SQLite || 3.8.2 || |
| 66 | || PostgreSQL || 9.3.6 || |
| 67 | || MySQL || 5.5.41, 5.6.19 || |
| 68 | || MariaDB || 5.5.41 || |
| 69 | || psycopg2 || 2.4.5 || |
| 70 | || MySQLdb || 1.2.3 || |
| 71 | || SetupTools || 3.3.1 || |
| 72 | || Git || 1.9.1 || |
| 73 | || Subversion || 1.8.8 || |
| 74 | || !ConfigObj || 4.7.2 || |
| 75 | || !DocUtils || 0.11 || |
| 76 | || Textile || 2.1.5 || |
| 77 | || Pygments || 1.6 || |
| 78 | |
| 79 | === Deprecated Modules Removed |
| 80 | |
| 81 | === New Dependencies |
| 82 | |
| 83 | == Detailed List of Developer Visible Changes #list |
| 84 | |
| 85 | [[TicketQuery(milestone=1.3.1,status=closed,apichanges!=,col=summary,rows=apichanges,group=component,format=table)]] |
| 86 | |
| 87 | == Other Modifications made to the 1.2 API |
| 88 | |
| 89 | === Uncategorized Changes |
| 90 | |
| 91 | == New in the 1.3.1 API |
| 92 | |
| 93 | Be sure to have a look at the new ApiDocs ([http://www.edgewall.org/docs/trac-trunk/html/ for latest trunk]). |
| 94 | |
| 95 | //This is a work in progress - coverage is still not yet complete.// |
| 96 | |
| 97 | |
| 98 | {{{#!comment |
| 99 | === New Classes |
| 100 | ==== `trac.x.y.ClassName` ^[source:trunk/trac/x/y.py@#Lnum (1.0)]^ #ClassName |
| 101 | |
| 102 | ... |
| 103 | |
| 104 | === Other news |
| 105 | |
| 106 | }}} |