Loading...
 

How to figure out what revision number causes a bug


Something worked. And now it doesn't. This is called a regression.

This happens. Most commits fix/improve things, but every once in a while, something breaks. Sometimes, by fixing a bug, we introduce another. Tiki has so many features that it's difficult to test everything. Lots of eyeballs and good bug reporting is essential

You'd like to report the bug and inform the right person. But how to figure out who introduced the problem and when?

You can use SVN-bisect or the manual procedure below. (Could http://code.google.com/p/phpsvnclient/ be used as well?)

  1. You should subscribe to SVN mailing list to be informed of all fixes and to search in your mail client
    • This is a high-volume list so you may want to put a filter to store messages in a directory
  2. Get Tiki via SVN (choose your branch)
  3. Check your version number.
    svn info
    $ svn info
    Path: .
    url: http://svn.code.sf.net/p/tikiwiki/code/branches/7.x
    Repository Root: http://svn.code.sf.net/p/tikiwiki/code/
    Repository UUID: b456876b-0849-0410-b77d-98878d47e9d5
    Revision: 34719
    Node Kind: directory
    Schedule: normal
    Last Changed Author: jonnybradley
    Last Changed Rev: 34716
    Last Changed Date: 2011-05-31 10:42:10 -0700 (Tue, 31 May 2011)


  4. Update SVN to a specific revision which you know works.
    To update your source to a specific revision, use:
    Updating to revision 34715
    [demotw@alpha 7x]$ svn update -r 34715
    U    lib/categories/categlib.php
    U    templates/categobjects_title.tpl
    U    templates/categobjects.tpl
    
    Fetching external item into 'lib/adodb'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/smarty'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/jscalendar'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/htmlpurifier'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/pclzip'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/jquery'
    
    Fetching external item into 'lib/jquery/jquery.s5'
    Updated external to revision 41.
    
    Fetching external item into 'lib/jquery/jquery.sheet'
    
    Fetching external item into 'lib/jquery/jquery.sheet/jquery-ui/ui'
    Updated external to revision 4075.
    
    Fetching external item into 'lib/jquery/jquery.sheet/jquery-ui/theme'
    Updated external to revision 4075.
    
    Updated to revision 405.
    Updated to revision 34668.
    
    Fetching external item into 'lib/phpcas'
    Updated external to revision 23921.
    
    Fetching external item into 'lib/ezcomponents'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/ckeditor'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/codemirror'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/svg-edit'
    Updated external to revision 2034.
    
    Fetching external item into 'lib/mobileesp'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/html5shim'
    Updated external to revision 34668.
    
    Fetching external item into 'lib/pear/Text'
    Updated external to revision 34720.
    
    Fetching external item into 'lib/core/Zend'
    Updated external to revision 24101.
    
    Updated to revision 34715.
    [demotw@alpha 7x]$


  5. Clear all caches by visiting tiki-admin_system.php?do=all
  6. Test to confirm the bug is not present
  7. Update SVN to a specific revision which you know doesn't work.
  8. Test to confirm the bug is present
  9. Repeat by changing revision number back & forth until you can pinpoint the revision which introduces the issue.
    Since you may have quite a few trial and errors, you may want to ignore externals, but an issue can be caused by an external...
    svn update --ignore-externals -r 34750

    * externals causing regressions should be gradually minimized as we tie our externals to specific stable versions
  10. Reply to the message on the SVN mailing list to specify what issue this commit is introducing.


Note: Database structure changes between version, so you may see bugs/error messages because of this. However, most of the time, it won't prevent you to use this method to pinpoint the problematic commit.


SVN-Bisect

How to install SVN-bisect on Ubuntu
$ sudo apt-get install svn-bisect

Tell svn-bisect good bad, until it gets the right commit number
# sudo svn-bisect start 43700 43800
# svn-bisect bad
# svn-bisect good
# svn-bisect bad
# svn-bisect bad
# svn-bisect good


Ref:
http://manpages.ubuntu.com/manpages/lucid/en/man1/svn-bisect.1.html

Related


alias

Contributors to this page: Karen Stingel , Jean-François BILGER and Marc Laporte .
Page last modified on Thursday 21 February, 2013 20:15:35 UTC by Karen Stingel.

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting 7.x
Administration
Ajax 2.x
Articles & Submissions
Backlinks
Banner
Batch 6.x
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Credits 6.x
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
DogFood
Draw 7.x
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping 3.x
Mobile Tiki and Voice Tiki
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Payment 5.x
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Score
Search engine optimization (SEO)
Search
Security
Semantic links 3.x
Share
Shopping Cart 5.x
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags 2.x
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests 2.x
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
WebHelp
Webmail and Groupmail
WebServices 3.x
Wiki 3D
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives 4.x
WYSIWTSN 4.x
WYSIWYCA
WYSIWYG 2.x
XMLRPC




Useful Tools