Skip to main content

Version control and outside contributors

The version control system your project uses can have a big impact on how easy it is for outside contributors to help out.

Svn (and cvs) make it difficult to contribute

Most projects restrict new or minor contributors to read only permission on their code repositories. This is common both for security and for organizational purposes, project maintainers often like to review changes before they go into mainline code. Read only access has its downside for contributors. If someone like myself wanted to contribute to a project that used svn the flow wold look something like:

- svn checkout
- Edit files in my editor
- Test
- svn diff > changes.patch
- Email/post changes to maintainer
- Wait until the changes are approved or rejected and checked in to svn
- Repeat starting at 'Edit files in my editor'

The bottleneck here is waiting for changes to be checked into svn. What if there were several changes in series? How would I be able to continue working on the next change if one change was already pending? What if the project maintainer(s) took a week to approve/reject or check in the changes?

Svn's centralized design is extremely constraining to rapid development and experimentation.

Making things easier with decentralized version control

Git and other decentralized version control systems solve the issues mentioned above. Git, for instance, enables users to check in any number of changes as well as create branches freely.

What if you want to use git but the project you'd like to contribute to is using svn? Github is a great resource that can help. They provide free hosting and have a helpful page about how to import a svn project into git.

Recently I wanted to start contributing to EmbSysRegView but the project is still using svn. I've been using git for several years now and at my full-time job for a year or two since I was able to convince the team to migrate from svn. I'd prefer to work in git because I could make several changes without having to wait for the maintainers. Plus git is a much faster tool.

It might be possible to convince the maintainer(s) to switch to git but this can be a bit of a learning process for them and other contributors. It turns out that patch files from git commits can be made compatible with svn in most cases. Git also has support for interacting with svn repositories natively. You can both import changes from svn as they are made and push changes back to svn repositories from git commits.

I decided to go this route and use github to host an import of the EmbSysRegView svn project. It took a few minutes but I was able to import the entire project including its history, tags etc, into a github project.


EmbSysRegView on github
Now that the project is in git it should be easy for me to make a series of changes, submit them as patches to the EmbSysRegView maintainers, and easily rewrite patches from their feedback.



Labels:

Comments

Post a Comment

Popular posts from this blog

UTM (qemu on OSX) only boots into uefi shell after installing Ubuntu 22.10 (solved!)

I've been meaning to try out running Linux and Windows virtual machines on my x86 MacBook Pro using qemu . I've been using Parallels for several years. Parallels is a nice application and works well but I'm always getting bugged to purchase upgrades. Parallels provides free updates on minor version upgrades only, say 13.0 to 13.1. With so many prompts to purchase upgrades it feels like Parallels could release a bit more minor versions and a bit fewer major versions. Rather than just purchase an upgrade to Parallels I figured I'd try out qemu via the UTM application . UTM wraps qemu with a helpful gui and comes as a packages Mac application. And UTM supports both x86 and M1 systems (as qemu also supports these systems). Creating an Ubuntu VM with UTM didn't go as smoothly as with VirtualBox or Parallels but it was the settings I chose that messed me up. Here are two things I ran into when installing Ubuntu on UTM. #1. Configure the qemu instance to use a 'Display...
Post a Comment
Read more

Debugging an imprecise bus access fault on a Cortex-M3

This information may apply to other cortex series processors but is written from practical experience with the Cortex-M3. Imprecise bus access faults are ambiguous, as noted by the term "imprecise". Compared to precise bus errors, imprecise errors are much trickier to debug and especially so without a deep understanding of arm processors and assembly language. Imprecise and precise flags are found in the BusFault status register, a byte in the CFSR (Configurable Fault Status Register). BusFault status register bits The definition for imprecise and precise bits is: [2] IMPRECISERR Imprecise data bus error: 0 = no imprecise data bus error 1 = a data bus error has occurred, but the return address in the stack frame is not related to the instruction that caused the error. When the processor sets this bit to 1, it does not write a fault address to the BFAR. This is an asynchronous fault. Therefore, if it is detected when the priority of the current pr...
5 comments
Read more

Graco Swing By Me - Battery to AC wall adapter modification

If you have one of these Graco battery powered swings you are probably familiar with the cost of C batteries! The swing takes four of them and they only last a handful of days. I'm not sure if the newer models support being plugged into the wall but ours didn't. If you are a little familiar with electronics and soldering, here is a rough guide on how you can modify yours to plug in! I wasn't sure how exactly to disassemble the swing side where the batteries were. I was able to open up the clamshell a bit but throughout this mod I was unable to determine how to fully separate the pieces. I suspect that there is some kind of a slip plate on the moving arm portion. The two parts of the plastic are assembled and the moving arm portion with the slip plate is slid onto the shaft. Because of the tension in that slip plate it doesn't want to back away, and because of the mechanicals that portion of the assembly doesn't appear accessible in order to free it. I was...
Post a Comment
Read more