Rockbox

This is the bug/patch tracker for Rockbox. Click here for more information.

Quick links: Bugs · Patches · Rockbox frontpage

Tasklist

FS#9758 - Make svnversion agnostic to version control mechanism

Attached to Project: Rockbox
Opened by Alex Bennee (ajb) - Sunday, 04 January 2009, 15:34 GMT+2
Last edited by Andrew Mahone (Unhelpful) - Monday, 19 January 2009, 17:53 GMT+2
Task Type Patches
Category Build environment
Status Closed
Assigned To No-one
Player Type All players
Severity Low
Priority Normal
Reported Version Daily build (which?)
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Private No

Details

The current attempt to deal with git repos fails if it's not a svn-repo (which is won't be if people have synced of the rockbox git repo). This patch makes the version script agnostic about git-svn and use Linux style id if git is detected.
   0001-Make-handling-of-git-repos-more-bullet-proof... (5.8 KiB) 
 b/tools/configure     |    2 -
 a/tools/svnversion.sh |   59 -------------------------------------
 b/tools/version.sh    |   79 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 80 insertions(+), 60 deletions(-)

This task depends upon

Closed by  Andrew Mahone (Unhelpful)
Monday, 19 January 2009, 17:53 GMT+2
Reason for closing:  Accepted
Additional comments about closing:  committed as r19799
Comment by Andrew Mahone (Unhelpful) - Monday, 05 January 2009, 00:18 GMT+2
I like your detection of "dirty" status of the repository, but I believe we should still report the latest SVN revision in the git repository as part of the version string. This can be done without git-svn by examining the log of the current branch, since git-svn commits are marked as such.
Comment by Alex Bennee (ajb) - Monday, 05 January 2009, 13:24 GMT+2
But how do you determine which log entry? After all most developers
using git will have their own commits on top. Ultimately the reported
version is most useful to the person that built that build. The git
commit ID marks exactly where and what revision history a given change
has. They can easily refer to a subversion revision if reporting
anything to Flyspray manually.
Comment by Andrew Mahone (Unhelpful) - Monday, 05 January 2009, 15:10 GMT+2
I dealt with it by searching for the most recent commit, via git log, with a git-svn-id. There's no reason the SVN revision could not be included with the git commit ID, although at that point it might be getting too long to read on the screen... you're probably right, though, in that only developers are using git, and if they build test builds from it for users, it's enough that the developer knows what to do with the git commit ID.
Comment by Alex Bennee (ajb) - Sunday, 11 January 2009, 15:19 GMT+2
Changes:

Removed extraneous tag checking code (hangover from Linux kernel)
Detected git-svn-id in HEAD commit message and will echo "grNNNNN" if in sync with SVN
   0001-Not-all-repos-are-ones-created-with-git-svn-... (6 KiB) 
 b/tools/configure     |    2 -
 a/tools/svnversion.sh |   59 ----------------------------------
 b/tools/version.sh    |   85 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 86 insertions(+), 60 deletions(-)

Comment by Alex Bennee (ajb) - Monday, 12 January 2009, 13:23 GMT+2
Following Andrews comment: http://www.rockbox.org/irc/log-20090111#16:26:53

"it's probably going to need to report the most recent git-svn commit regardless of whether it's HEAD or not. people want it to always show where the build fits in the svn repo, and at least some are against even appending a git commit ID."

I've changed the logic so a pure git commit will report and ID like: gd53f268(~r19748)-090112 which means git commit-ish d53f268 which is rooted from r19748
   git_gitsvn_version_v3.patch (5.3 KiB) 
 b/tools/configure     |    2 -
 a/tools/svnversion.sh |   59 ---------------------------------
 b/tools/version.sh    |   87 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 88 insertions(+), 60 deletions(-)

Comment by Alex Bennee (ajb) - Monday, 12 January 2009, 17:34 GMT+2
Changes:

Fixed -dirty handling
   git_gitsvn_version_v4.patch (5.3 KiB) 
 b/tools/configure     |    2 -
 a/tools/svnversion.sh |   59 ----------------------------------
 b/tools/version.sh    |   86 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 87 insertions(+), 60 deletions(-)

Comment by Andrew Mahone (Unhelpful) - Saturday, 17 January 2009, 02:52 GMT+2
Several devs on IRC seems to agree about keeping the version string short, simple, and in the same format across targets. This is a modified patch that outputs rNNNNN[M]-DDDDDD version strings for git repositories, with the optional "M" appearing if the commit at HEAD is not from svn, or if the working tree contains changes to existing files, or any other changes (file add/delete/rename) that have been staged for commit with git add. I can commit this now, if the mechanism is considered generally acceptable, and leave the task open to work on adding more complete info to rockbox-info.txt - this file is already included in builds, and could have "Git commit ID" and "Git working tree status" fields added.

The major objections to extending the version string itself are that differences based on version control systems may confuse users, and that the existing version string already barely fits the screen on some targets, and actually goes over by a few pixels with the "M" for modified. Such targets would end up seeing nothing in the bootloader display with a -<commitID> added to the version string, and if we have to ask users to look at the version via the menu to get the commit ID, they may as well look at rockbox-info.txt.
   git_gitsvn_version_am-200901162042.patch (5.2 KiB) 
 b/tools/configure     |    2 -
 a/tools/svnversion.sh |   59 -----------------------------------
 b/tools/version.sh    |   83 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 84 insertions(+), 60 deletions(-)

Comment by Alex Bennee (ajb) - Monday, 19 January 2009, 16:53 GMT+2
As Andrews patch but with commentary fixed.
   git_gitsvn_version_v5.patch (5.1 KiB) 
 b/tools/configure     |    2 -
 a/tools/svnversion.sh |   59 -----------------------------------
 b/tools/version.sh    |   84 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 85 insertions(+), 60 deletions(-)

Loading...