CinelerraReview

Revision 5 as of 2007-02-13 20:28:55

Clear message

CinelerraReview

Reviewing the licence of the Cinelerra source tree.

Scope

We need to review the Cinelerra-CV sources that muzzol has pushed to bzr. The branch can be seen at [https://code.launchpad.net/~ubuntustudio-dev/+branch/ubuntustudio/cinelerra], and there are instructions there for pulling it.

Use Cases

  • Bob wants to use Cinelerra and Ubuntu to edit his video, and doesn't want to use a non-free equivalent. However, he is unable to, nor does he want to, build Cinelerra himself.
    • We need to get Cinelerra into the repository. This cannot happen unless all licence issues are sorted, and thus the purpose of this spec.

Design

The task could be done in either of two ways, both of which I will outline below.

1. We each create, on Launchpad, a branch of ~ubuntustudio-dev/ubuntustudio/cinelerra (thus becoming ~<user>/...). Each branch has the file, say, ./LICENCES in it, where each reviewer keeps a note of the licence of every source file they have reviewed. When the reviews have finished, all the personal branches are merged back into ~ubuntustudio-dev.

2. We each pull from and push to the ~ubuntustudio-dev branch. Each reviewer has their own file in which they update their list of files and licences. This file could be called something like ./LICENCES.<reviewer>. When the reviews are complete, these files can be merged into one file, ./LICENCES, or debian/copyright.

Implementation

As the source tree is 438MiB at last clone (268MiB used up by bzr), the first method seems like too much uploading - to create new branches for each of us, and then make a merge at the end. It would almost double the amount of up/down traffic we need. As a result, I suggest we choose to follow method 2.

However, either way we will need to decide how to split the 72030 files in the source tree between the team. It does indeed look a daunting task, but if divided up properly, it can be made much easier. It may be possible to have a system of locking, where we each check each others' LICENCES files, where it would be specified which files have been and will be done.We could also have a page like UbuntuStudio/ToPackage, where we divide up and allocate the sources. Either way, we cannot waste time stepping on toes.

(The below was taken from my post to the UbuntuStudio mailing list).

Due the the upstream SVN server, I have been unsuccessful in having Launchpad import the repository automatically. However, I have done so manually, and you can find the clean and current-ish trunk at ~cinelerra-ubuntu/cinelerra-cv/trunk, and my cleaned-up version of muzzol's branch at ~cinelerra-ubuntu/cinelerra-cv/2.1.0+svn20070109. When Launchpad is able to do imports automatically, I will be the first (maybe second) to hear, and will set that up again.

We need to decide firmly how we are not going to step on each others' toes. I propose a page like ToPackage (say, at wiki.ubuntu.com/Cinelerra/LicenceReviewStatus). We list what directories we are reviewing, and how many files we have to review, and how many are remaining. These last two points are easy to address. We each create a text file, with the name of the file, and the licence of the file, or "none specified" if we can't find it. This text file will only contain files we have reviewed. We can see how many we have done with wc -l <file>, and how many are total by find <directory> | wc -l. Easy, as long as each file has a separate file. When all the files have been checked, we take every reviewer's file, and merge them so that we have one master file within which the number of lines should, hopefully, equal the number of files in the branch. We can record our statuses on the wiki, maybe even have the list-files on there as well. Or we can maintain them locally and compile them together when done. Either way should work. We can even keep the files in the branch.

Remember, try and always push to ~cinelerra-ubuntu/cinelerra-cv/2.1.0+svn20070109 (every member of ubuntustudio-dev is a member of cinelerra-ubuntu, but I'd still like a distinction between those that maintain Cinelerra - cinelerra-ubuntu - and those that maintain UbuntuStudio - ubuntustudio-dev - even if we are the same at first), and keep the filenames in a standard format, ie licences-list.<name>.

Once we have this structure done we should post to the Cinelerra ML. Invite people to help.

Comments


CategorySpec