Importing Docs CVS modules to git

From FedoraProject

Jump to: navigation, search

This document demonstrates how to turn a Docs CVS module into a git repo.

Contents

Create author file

Get the script found here: http://pfrields.fedorapeople.org/scripts/authors-from-fas2-group.py

Make sure you have the python-fedora package installed:

su -c 'yum install python-fedora'

Run the script:

python authors-from-fas2-group.py

Provide your FAS username and password, and the group name docs. You will also need to run it again with the group name cvsl10n. Use the cat command to copy both sets of results (in any order) to a single file authors.txt.

Note.png
The authors.txt file
When you're finished with importing Docs CVS modules, don't bother to retain the authors.txt file, as the results are expected to change over time.


Getting started

Whether you're working with branched or non-branched CVS modules, you obviously need to install git:

su -c 'yum install git-all'

Then make a directory for your new git repository:

mkdir -p <GITREPODIR>


Converting modules

Non-branched CVS modules

Run git-cvsimport for the module. Substitute the directory you just made for <GITREPODIR>, and the module name (like "foo-guide") for <MODULE>.

Note.png
Keep in mind
The \ character indicates a line wrap, so this command is one line.
git-cvsimport -d :pserver:anonymous@cvs.fedoraproject.org:/cvs/docs  \
-S docs-common -v -C <GITREPODIR> -u -p x -a -A ~/authors.txt <MODULE>

This could take quite a while, depending on the size of the repository and the speed of your network connection.


Branched CVS modules

Branched CVS modules have a directory for each release of Fedora (i.e. F-7, F-8, and so on). To convert them, do this:

  1. Create the master branch from the contents of the devel CVS module directory:
    git-cvsimport -d :pserver:anonymous@cvs.fedoraproject.org:/cvs/docs  \
    -S docs-common -v -C <GITREPODIR> -u -p x -a -A ~/authors.txt <MODULE>/devel
  2. Look for tags that reveal where versions were branched. If you're lucky, you'll see tags like <MODULE>-8.0, or something to that effect.
    git tag
    If you don't, that means no one tagged the source at the appropriate point. Unfortunately, Docs CVS never had any enforcing build system like the Package CVS. However, you can do a little sleuthing in a document's content, or in the CVS history, to find out the date when it was branched. Then find the git commit message for that branching, or the last one before that date, and use that as your branch point.
  3. Use the tag or the date to create a new branch in your local git repository. Use a branch name like f21 for the <BRANCH>.
    git checkout -b <BRANCH> <TAG_NAME_or_COMMIT>
  4. You are now on the new branch automatically. Do a git-cvsimport from the appropriate CVS branch directory -- <CVS_BRANCH> might be F-8 for instance. Don't forget the -o <BRANCH> option in this command!
    git-cvsimport -d :pserver:anonymous@cvs.fedoraproject.org:/cvs/docs  \
    -S docs-common -v -C <GITREPODIR> -u -p x -a -A ~/authors.txt  \
    -o <BRANCH> <MODULE>/<CVS_BRANCH>
    Repeat the above steps for each Fedora release that has a branch directory in CVS. Make a new git branch for each!

Now you're ready to use this content for your new repository.

Pushing a new branch

If you need to push the results of the previous procedure to an existing repo, make sure you are still on the new branch with the git branch command. You must have commit rights to the repository in question, which you should have if you used a git+ssh:// protocol to check out the repository. Then push with this command, substituting the branch name for <BRANCH>:

git push origin <BRANCH>