Edgewall Software

Changeset 17718


Ignore:
Timestamp:
Sep 23, 2023, 12:26:43 AM (6 days ago)
Author:
Ryan J Ollos
Message:

1.6dev: Sync from t.e.o wiki

Refs #13333

Location:
trunk
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/RELEASE.rst

    r17378 r17718  
    11Release Notes for Trac 1.6 'Py3' Release
    22===========================================
    3 Not yet released
     3September 23, 2023
    44
    55Highlights
    66----------
     7* Supports Python 3.5 and later.
     8* Drop support for Python 2.
    79
    810Detailed User Visible Changes
  • trunk/trac/wiki/default-pages/InterMapTxt

    r17672 r17718  
    8585SO  https://stackoverflow.com/questions/ # Question $1 in StackOverflow
    8686
    87 Transifex https://www.transifex.com/projects/p/trac/
     87Transifex         https://www.transifex.com/cboos/trac/
     88TransifexLang     https://www.transifex.com/cboos/trac/language/$1/
     89TransifexResource https://www.transifex.com/cboos/trac/$1/
     90TransifexView     https://www.transifex.com/cboos/trac/viewstrings/#$1/$2
    8891
    8992kwquery      /query?group=status&keywords=~  # Custom query for tickets matching keyword $1
  • trunk/trac/wiki/default-pages/TracChangeLog

    r17674 r17718  
    44
    55To see where Trac is going in future releases, see the [trac:roadmap Roadmap].
     6
     7== 1.6.x Releases
     8
     9=== '''1.6 'Py3''''
     10
     11//(September 23, 2023)//
     12
     13Trac 1.6 is the first major release of Trac in almost 4 years.
     14
     15This is the first release to support Python 3, supporting Python
     163.5 and later. Python 2 is no longer supported.
     17
     18For more information see the [trac:wiki:TracDev/ApiChanges/1.6 API changes] and the detailed
     19release notes for [[trac:wiki:TracDev/ReleaseNotes/1.6|1.6]] and the change log for [#a1.5.xReleases 1.5.x Releases] below.
     20
     21[trac:source:/tags/trac-1.6 View Tag] | [trac:milestone:1.6 View Milestone]
    622
    723== 1.5.x Releases
     
    5672
    5773== 1.4.x Releases
     74
     75=== 1.4.4
     76
     77//(August 11, 2023)//
     78
     79Trac 1.4.4 contains about a dozen minor fixes
     80and improvements.
     81
     82[trac:source:/tags/trac-1.4.4 View Tag] | [trac:milestone:1.4.4 View Milestone]
     83
     84=== 1.4.3
     85
     86//(May 9, 2021)//
     87
     88Trac 1.4.3 contains about a dozen minor fixes
     89and improvements.
     90
     91[trac:source:/tags/trac-1.4.3 View Tag] | [trac:milestone:1.4.3 View Milestone]
     92
     93=== 1.4.2
     94
     95//(June 17, 2020)//
     96
     97Trac 1.4.2 has more than a dozen minor fixes and
     98improvements, including the following highlights:
     99
     100* Batch modify has autopreview for comment textarea
     101  and better form styling ([trac:#13285]).
     102* TracAdmin `config remove <section>` command
     103  deletes a configuration section ([trac:#13305]).
     104
     105[trac:source:/tags/trac-1.4.2 View Tag] | [trac:milestone:1.4.2 View Milestone]
    58106
    59107=== 1.4.1
  • trunk/trac/wiki/default-pages/TracPlugins

    r17585 r17718  
    77== Plugin discovery
    88
    9 A plugin is either a single .py file or a package (.egg or .whl). Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Plugins installed to the project environment `plugins` directory are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file.  Plugins installed elsewhere must be explicitly enabled in the [TracIni#components-section "[components]"] section of the `trac.ini` file.
     9A plugin is either a single .py file or a package (.egg or .whl). Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Plugins installed to the project environment `plugins` directory are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file. Plugins installed elsewhere must be explicitly enabled in the [TracIni#components-section "[components]"] section of the `trac.ini` file.
    1010
    1111== Installing a Trac plugin
    1212
    13 The instructions below are applicable to a plugins installed as packages. Plugins implemented as a single `py` file should be downloaded and copied to the [TracEnvironment project environment] `plugins` directory or the [TracIni#GlobalConfiguration global shared] plugins directory.
     13The instructions below are applicable to plugins installed as packages. Plugins implemented as a single `py` file should be downloaded and copied to the [TracEnvironment project environment] `plugins` directory or the [TracIni#GlobalConfiguration global shared] plugins directory.
    1414
    1515=== For a single project
     
    2525* Copy the egg file to the `plugins` directory of the [TracEnvironment project environment].
    2626
    27 Make sure the web server has sufficient permissions to read the plugin egg and restart the web server. If you are running as a [TracStandalone "tracd" standalone server], restart tracd (i.e. kill the process and run again).
     27Make sure the web server has sufficient permissions to read the plugin egg and restart the web server. If you are running as a [TracStandalone "tracd" standalone server], restart tracd, i.e. kill the process and run again.
    2828
    2929Trac also searches for plugins installed in the [TracIni#GlobalConfiguration global shared] plugins directory. This is a convenient way to share the installation of plugins across several, but not all, environments.
     
    4343The modern Python package manager, `pip`, is included in Python 2.7.9 and later. In earlier versions of Python it can be installed through the package manager of your OS (e.g. `apt-get install python-pip`) or using [https://pip.pypa.io/en/latest/installing.html#install-pip get_pip.py].
    4444
    45 Using `pip`, the plugin will be installed
    46 in the [https://pythonwheels.com/ wheel format], which is the modern standard for Python and a
    47 replacement for the egg format.
     45Using `pip`, the plugin will be installed in the [https://pythonwheels.com/ wheel format], which is the modern standard for Python and a replacement for the egg format.
    4846
    4947==== From PyPI
     
    5654The version can be specified, which can be useful if you don't want to install the latest:
    5755{{{#!sh
    58 $ pip install TracTags==0.10
     56$ pip install TracTags==1.2
    5957}}}
    6058
     
    6664}}}
    6765
    68 Replace the `svn+` prefix with `git+` if installing
    69 from a Git repository.
     66Replace the `svn+` prefix with `git+` if installing from a Git repository.
    7067
    7168Or from the path or URL of a tar.gz or zip archive:
     
    9895==== Upgrading the environment
    9996
    100 Some plugins require an environment upgrade. This will typically be necessary for plugins that implement `IEnvironmentSetupParticipant`. Common reasons for requiring an environment upgrade are to add tables to the database or add configuration parameters to trac.ini. A notification will be displayed when accessing Trac for the first time after installing a plugin and restarting the web server. To upgrade the environment, run the command:
     97Some plugins require an environment upgrade. This will typically be necessary for plugins that implement `IEnvironmentSetupParticipant`. Common reasons for requiring an environment upgrade are to add tables to the database or add configuration parameters to `trac.ini`. A notification will be displayed when accessing Trac for the first time after installing a plugin and restarting the web server. To upgrade the environment, run the command:
    10198
    10299{{{#!sh
     
    108105==== Redeploying static resources
    109106
    110 If you [TracInstall#MappingStaticResources mapped static resources] so they are served by the web server, and the plugin contains static resources (CSS, !JavaScript and image files), the resources will need to be deployed to the location on the filesystem that is served by the web server.
     107If you [TracInstall#MappingStaticResources mapped static resources] so they are served by the web server, and the plugin contains static resources, such as stylesheets, !JavaScript and image files, the resources will need to be deployed to the location on the filesystem that is served by the web server.
    111108
    112109Execute the `deploy` command, as is done during install and [TracUpgrade#a5.Refreshstaticresources upgrade]:
     
    190187'''Note''': !SetEnv requires the `mod_env` module, which needs to be activated for Apache. In this case the !SetEnv directive can also be used in the `mod_python` Location block.
    191188
    192 For [TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
     189For [TracFastCgi FastCGI], you will need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
    193190
    194191'''Note''': if you already use -initial-env to set the project directory for either a single project or parent, you will need to add an additional -initial-env directive to the !FastCgiConfig directive:
     
    213210=== Did you get the correct version of the Python egg?
    214211
    215 Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.5.egg` is an egg for Python 2.5, and will '''not''' be loaded if you're running a different Python version (such as 2.4 or 2.6).
     212Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.5.egg` is an egg for Python 2.5, and will '''not''' be loaded if you're running a different Python version, such as 2.4 or 2.6.
    216213
    217214Also, verify that the egg file you downloaded is indeed a .zip archive. If you downloaded it from a Trac site, you may have downloaded the HTML preview page instead.
     
    244241* Only one version of the plugin can be loaded for each running Trac server, i.e. each Python process. The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is `enabled` or `disabled` makes no difference.
    245242* A globally installed plugin will override any version in the global or project plugins directories. A plugin from the global plugins directory will be discovered ''before'' any project plugins directory.
    246 * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), having two versions of a plugin in two different projects will give unpredicatable results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first plugin found, usually from the project that receives the first request.
     243* If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), having two versions of a plugin in two different projects will give unpredictable results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first plugin found, usually from the project that receives the first request.
    247244* Having more than one version listed inside Python site-packages is fine, because setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory: neither the version number nor the installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins.
    248245
  • trunk/trac/wiki/default-pages/TracRepositoryAdmin

    r17585 r17718  
    44== Quick start #QuickStart
    55
     6Trac is primarily used as an issue tracking and project planning system, but can also be used to connect to and maintain source code repositories. This page describes the guidelines and caveats when connecting Trac to a repository.
    67 * Enable the repository connector(s) for the version control system(s) that you will use.
    78 * Add repositories through the //Repositories// admin page, using `trac-admin` or by editing the `[repositories]` section of [[wiki:TracIni#repositories-section|trac.ini]].
     
    1112== Enabling the components
    1213
    13 Support for version control systems is provided by optional components distributed with Trac, which are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them.
     14Support for version control systems is provided by optional components distributed with Trac, which are disabled by default. Subversion and Git must be explicitly enabled if you wish to use them.
    1415
    1516The version control systems can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components through the //Plugins// admin page.
     
    3940=== Repository Attributes
    4041
    41 There are a number of attributes that can be specified for each repository, and additional attributes may be available through plugins. A repository `name` and one of the `alias` or `dir` attributes are mandatory. All others are optional.
    42 
    43 The following attributes are supported:
     42A repository is defined through the attribute `name` and one of the `alias` or `dir` attributes, all other attributes are optional:
    4443
    4544||='''Attribute''' =||='''Description''' =||
     
    5150||The text specified in the `description` attribute is displayed below the top-level entry for the repository in the source browser. It supports WikiFormatting. ||
    5251||`dir` ||\
    53 ||The `dir` attribute specifies the location of the repository in the filesystem. The `alias` and `dir` attributes are mutually exclusive. ||
     52|| Specifies the location of the repository in the filesystem. The `alias` and `dir` attributes are mutually exclusive. ||
    5453||`hidden` ||\
    5554|| When set to `true`, the repository is hidden from the repository index page in the source browser. Browsing the repository is still possible, and links referencing the repository remain valid. ||
     55||`name` ||\
     56|| Identifies the version control system used by the repository. This field is mandatory. ||
    5657||`sync_per_request`||\
    5758|| When set to `true` the repository will be synchronized on every request (implicit synchronization). This is generally not recommended. See [#Synchronization repository synchronization] for a comparison of explicit and implicit synchronization. The attribute defaults to `false`. ||
    5859||`type` ||\
    59 || The `type` attribute specifies the version control system used by the repository. Trac provides support for Subversion and Git, and plugins add support for several other systems. If `type` is not specified, it defaults to the value of the `[versioncontrol]` [wiki:TracIni#versioncontrol-default_repository_type-option default_repository_type] option. ||
     60|| Specifies the version control system used by the repository. Trac provides support for Subversion and Git, and plugins add support for several other systems. If `type` is not specified, it defaults to the value of the `[versioncontrol]` [wiki:TracIni#versioncontrol-default_repository_type-option default_repository_type] option. ||
    6061||`url` ||\
    61 || The `url` attribute specifies the root URL to be used for checking out from the repository. When specified, a "Repository URL" link is added to the context navigation links in the source browser, that can be copied into the tool used for creating the working copy. ||
     62|| Specifies the root URL to be used for checking out from the repository. When specified, a "Repository URL" link is added to the context navigation links in the source browser, that can be copied into the tool used for creating the working copy. ||
     63
     64Additional attributes may be available through plugins.
    6265
    6366=== Scoped Repository
     
    274277=== Git control files missing
    275278
    276 If your repository is not browseable and you find a message in the log that looks like:
     279If your repository is not browsable and you find a message in the log that looks like:
    277280{{{
    2782812017-08-08 10:49:17,339 Trac[PyGIT] ERROR: GIT control files missing in '/path/to/git-repository'
     
    280283}}}
    281284
    282 First check that the path to your repository is correct. If the path is correct, you may have a permission problem whereby the web server cannot access the repository. You can use Git to verify the repository. On a Debian-like Linux OS, the following command should help:
     285First check that the path to your repository is correct. If the path is correct, you may not have the permission to have the web server access the repository. You can use Git to verify the repository. On a Debian-like Linux OS, the following command should help:
    283286{{{#!sh
    284287$ sudo -u www-data git --git-dir=/path/to/git-repository fsck
Note: See TracChangeset for help on using the changeset viewer.