Changes between Version 24 and Version 25 of TracTicketChangesetsPlugin

Timestamp:

Nov 12, 2015, 10:57:57 AM (8 years ago)

Author:

figaro

Comment:

Rearranged paragraphs to maintain consistency, further cosmetic changes

TracTicketChangesetsPlugin

@@ -5 +5 @@
 == Description
 
-The TracTicketChangesetsPlugin hooks into changeset notifications and searches commit messages for ticket references. Referenced tickets are updated with the commit message, and all concerning changesets for a ticket are presented in a separate section on ticket pages, just above the change history section.
+This plugin hooks into changeset notifications and searches commit messages for ticket references. Referenced tickets are updated with the commit message, and all concerning changesets for a ticket are presented in a separate section on ticket pages, just above the change history section.
 
 The source of this plugin is based on code distributed with Trac 0.12: `tracopt/ticket/commit_updater.py`. The plugin works with multiple repositories. Language is translated if Babel is installed.
 
-'''This plugin is not compatible with Trac 0.11 or older versions.''' If you have ChildTicketsPlugin installed, you should upgrade to 2.4.2 or later (#8755, #8756).
+'''Note:''' This plugin is not compatible with Trac 0.11 or older versions. If you have ChildTicketsPlugin installed, you should upgrade to 2.4.2 or later (#8755, #8756).
 
 See also: TracTicketChangelogPlugin, TicketModifiedFilesPlugin
@@ -23 +23 @@
 [[TicketQuery(component=TracTicketChangesetsPlugin&group=type,format=progress)]]
 
-'''Note:''' The plugin currently does not reformat ticket-commit-messages produced by Trac 0.11 since I am not confident in how those are formatted. Please [http://trac-hacks.org/newticket?component=TracTicketChangesetsPlugin&owner=mrelbe&summary=Reformat+old+commit+messages request this] together with examples of old ticket-commit-messages, and I will add that capability to this plugin.
+'''Note:''' The plugin currently does not reformat ticket-commit-messages produced by Trac 0.11, since I am not confident in how those are formatted. Please [/newticket?component=TracTicketChangesetsPlugin&owner=mrelbe&summary=Reformat+old+commit+messages request this] together with examples of old ticket-commit-messages, and I will add that capability to this plugin.
 
 == Download
 
-Download the zipped source from [download:tracticketchangesetsplugin here].
+Download the zipped source from [export:tracticketchangesetsplugin here].
 
 == Source
 
-You can check out TracTicketChangesetsPlugin from [http://trac-hacks.org/svn/tracticketchangesetsplugin here] using Subversion, or [source:tracticketchangesetsplugin browse the source] with Trac.
-
-== Example
-
-The related changesets are presented just above the ordinary change history:
-
-[[Image(ticket_changesets_box.gif)]]
-
-When several repositories contains changesets relating to a ticket, the content will gracefully be split into one sub-section for each repository.
-
-The plugin can be configured to present the box as initially collapsed, or hidden completely when no changesets are related to the ticket. Revision ranges can be presented in compact form, for example [420-422] instead of [420] [421] [422].
-
-The macros `CommitMessage(repo, rev)` and `TicketChangesets(ticket)` are provided to present a commit message for a given repository and revision, and all changesets that are related to a given ticket.
-
-=== Console administration commands
-
-Console administration commands are available for retrieving and re-synchronizing ticket-changesets relations, and reformatting existing ticket commit messages.
-
-
- `trac-admin /path/to/env ticket_changesets diff`::
- Examine ticket commit messages before reformat.
-
- Generate a diff-like output for analysis before reformatting. The database will not be changed. Before this operation, you may want to run
-{{{
-trac-admin $ENV repository resync "*"
-}}}
-
-
- `trac-admin /path/to/env ticket_changesets get [ticketid]`::
- Get a comma-separated list of related revisions (#7267).
-
- List format:
-{{{
-#ticketid: rev/reponame,...
-...
-}}}
- "/reponame" is left out for the default repository.
-
- All tickets related to changesets are listed if ticketid is omitted, one ticket on each line. If no ticket-changesets relations exists in the database, "None" is displayed.
-
-
- `trac-admin /path/to/env ticket_changesets reformat` '''(DANGEROUS!)'''::
- Reformat ticket commit messages.
-
- Before this operation, you may want to run:
-{{{
-trac-admin $ENV repository resync "*"
-}}}
- and then analyse the output of
-{{{
-trac-admin $ENV ticket_changesets diff
-}}}
-
-
- `trac-admin /path/to/env ticket_changesets resync`::
- Re-synchronize ticket changesets with all repositories
-
- Relations between tickets and changesets are re-built by examining all commit messages, in all repositories, for ticket references. Ticket comments are neither updated nor added due to new discoveries.
-
- Before this operation, you may want to run:
-{{{
-trac-admin $ENV repository resync "*"
-}}}
+You can check out TracTicketChangesetsPlugin from [/svn/tracticketchangesetsplugin here] using Subversion, or [source:tracticketchangesetsplugin browse the source] with Trac.
 
 == Installation
 
  1. Install the plugin, even with locale support:
-{{{#!sh
+ {{{#!sh
 cd TracTicketChangesetsPlugin
 python setup.py install
 }}} 
  1. Enable the plugin by the following in your `trac.ini` file:
-{{{#!ini
+ {{{#!ini
 [components]
 ticketchangesets.* = enabled
 }}}
  1. Add the section `[ticket-changesets]` to configure the behaviour ''(default values are shown below)'':
-{{{#!ini
+ {{{#!ini
 [ticket-changesets]
 check_perms = true
@@ -146 +84 @@
  1. Re-format existing ticket commit messages: '''(DANGEROUS!)'''
     a. Produce a diff-like output for your analysis, which does not affect the database, before re-formatting existing commit messages:
- {{{#!sh
+    {{{#!sh
 trac-admin /path/to/env ticket_changesets diff > out.diff
 }}}
- Examine out.diff and assert that re-formatting is sensible before next step.
+    Examine out.diff and assert that re-formatting is sensible before next step.
     a. Re-format '''(DANGEROUS!)'''
- {{{#!sh
+    {{{#!sh
 trac-admin /path/to/env ticket_changesets reformat
 }}}
  1. Setup hook-scripts (Windows example, does not differ from official instructions applicable to Trac 0.12):[[br]]Note that you may have to set the environment variable `PYTHON_EGG_CACHE` to the same value as was used for the web server configuration before calling trac-admin, if you changed it from its default location. See t:TracRepositoryAdmin#ExplicitSync for more information.
     a. post-commit.cmd:
- {{{#!sh
+    {{{#!sh
 :: Trac 0.12 post-commit hook script for Windows
 ::
@@ -164 +102 @@
 }}}
     a. post-revprop-change.cmd:
- {{{#!sh
+    {{{#!sh
 :: Trac 0.12 post-revprop-change hook script for Windows
 ::
@@ -173 +111 @@
 
 From here-on tickets will be updated when referenced in a commit message, and the relation between tickets and revisions is automatically tracked.
+
+== Example
+
+The related changesets are presented just above the ordinary change history:
+
+[[Image(ticket_changesets_box.gif)]]
+
+When several repositories contains changesets relating to a ticket, the content will gracefully be split into one sub-section for each repository.
+
+The plugin can be configured to present the box as initially collapsed, or hidden completely when no changesets are related to the ticket. Revision ranges can be presented in compact form, for example [420-422] instead of [420] [421] [422].
+
+The macros `CommitMessage(repo, rev)` and `TicketChangesets(ticket)` are provided to present a commit message for a given repository and revision, and all changesets that are related to a given ticket.
+
+=== Console administration commands
+
+Console administration commands are available for retrieving and re-synchronizing ticket-changesets relations, and reformatting existing ticket commit messages.
+
+ `trac-admin /path/to/env ticket_changesets diff`::
+ Examine ticket commit messages before reformat.
+
+ Generate a diff-like output for analysis before reformatting. The database will not be changed. Before this operation, you may want to run:
+{{{#!sh
+trac-admin $ENV repository resync "*"
+}}}
+
+ `trac-admin /path/to/env ticket_changesets get [ticketid]`::
+ Get a comma-separated list of related revisions (#7267).
+
+ List format:
+{{{
+#ticketid: rev/reponame,...
+...
+}}}
+ "/reponame" is left out for the default repository.
+
+ All tickets related to changesets are listed if ticketid is omitted, one ticket on each line. If no ticket-changesets relations exists in the database, "None" is displayed.
+
+
+ `trac-admin /path/to/env ticket_changesets reformat` '''(DANGEROUS!)'''::
+ Reformat ticket commit messages.
+
+ Before this operation, you may want to run:
+{{{#!sh
+trac-admin $ENV repository resync "*"
+}}}
+
+ and then analyse the output of:
+{{{#!sh
+trac-admin $ENV ticket_changesets diff
+}}}
+
+ `trac-admin /path/to/env ticket_changesets resync`::
+ Re-synchronize ticket changesets with all repositories
+
+ Relations between tickets and changesets are re-built by examining all commit messages, in all repositories, for ticket references. Ticket comments are neither updated nor added due to new discoveries.
+
+ Before this operation, you may want to run:
+{{{#!sh
+trac-admin $ENV repository resync "*"
+}}}
 
 == About i18n/l10n support