Allow specific revision of a file in the repository to be specified
|Reported by:||Ryan J Ollos||Owned by:||Alexander Slesarev|
As noted in #6622, I'm having an issue getting the new
*CodeExamplePath macros to work, but from looking at the documentation, I have a suggestion that would improve a particular use case that I had in mind for this macro.
I don't have a good code review tool in place for my companies' SCM system, so we typically use tickets to track changes that result from code reviews. The ability to display code from the repository is a great feature that would fit well with our code review process, however a few changes would make it even more useful.
When performing code review, we identify particular segments of code that are bad in some way. These segments of code are subsequently fixed, so when identifying bad code in the ticket we'd like to include code from a specific revision of a file in the repository. The following concise syntax would be consistent with Trac's
source TracLink syntax:
This would display (highlight) lines 26-30 of from the path
/dir1/dir2/file1 at revision 436.
source TracLink has a similar syntax. If you wish to highlight lines 26-30 from the path
/dir1/dir2/file1 at revision 436, you'd use the syntax:
With this path specification in place, you could also consider just allowing path to be specified as an option to the existing
*CodeExample macros (rather than having a separate set of macros). For example:
Finally, with that in mind perhaps a link to the source code in the repository browser could be added to the code example box. In the example above, clicking somewhere in the code example box would take you to
source:/dir1/dir2/file1@436:26-30#L26. In the interest of keeping the Code Example box clean and simple, I'd be in favor of having Example be a link to the repository browser.