Changes between Version 28 and Version 29 of TracTicketChangesetsPlugin

Timestamp:

Jun 9, 2018, 9:06:29 AM (6 years ago)

Author:

figaro

Comment:

Moved example to description

TracTicketChangesetsPlugin

@@ -10 +10 @@
 
 '''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).
+
+The related changesets are presented just above the ordinary change history:
+
+[[Image(ticket_changesets_box.gif, border=2)]]
+
+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 "*"
+}}}
 
 See also: TracTicketChangelogPlugin, TicketModifiedFilesPlugin
@@ -115 +172 @@
 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, border=2)]]
-
-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