Tools

Linux Source Code

The e1000e network driver uses some functions which are the part of Linux kernel. You can find their definitions in Linux source code. You can download latest Linux kernel source code from kernel.org.

Cscope and Ctags

A very good tool to help you browse your source code: cscope
Index your source code using ctags
Use cscope/ctags with vi: Vim/cscope tutorial, Vim/ctags tutorial

Subversion

Subversion (SVN) is installed on all machines in the department cluster. You can install it on your machine using "apt-get install subversion".
The Computer Services Center provides a subversion server. To create a repository called "e1000e-repo":

$ ssh ssh1.iitd.ernet.in   # use your proxy password
$ mkdir svn
$ cd svn
$ svnadmin create e1000e-repo

You should see a subdirectory called e1000e-repo in the svn directory. Read e1000e-repo/README.txt. Do not add, delete, or modify any files in this subdirectory. Edit the svn/authz file to provide read-write permissions to e1000e-repo to yourself and your partners, and read permissions to anz107537. For example, if users cs1012345 and cs1067890 are partners and user cs1012345 is currently logged in, here is a sample authz file to use:

[/]
[e1000e-repo:/]
cs1012345@IITD.ERNET.IN = rw
cs1067890@IITD.ERNET.IN = rw
anz107537@IITD.ERNET.IN = r

Notice that your username should be suffixed with @IITD.ERNET.IN and not cse.iitd.ernet.in. These statements provide read/write access to the group partners and read access to the TA.

Set the directory permissions so that they look like the following:

drwx-----x for $HOME. (The permission of individual files in $HOME should be restricted only to the users, so that others can't peep into user's home)
drwx------ for $HOME/svn

The responsibility of maintaining the security of your repository lies with you. You will be penalized if your repository is found to be readable by other unauthorized people.

Go to one of the machines in the department cluster (or your local machine). Use the following command to checkout the files from your repository:

$ svn checkout https://svn.iitd.ernet.in/~cs1012345/e1000e-repo

You will be prompted for your CSC password. Do not offer to save the password in plaintext format in your home directory as that is insecure. You can add the following line to ~/.subversion/servers to avoid getting prompted for saving passwords in future:

store-plaintext-passwords = no

This should create a directory called e1000e-repo. Type the following commands to add the base e1000e files to the repository:

$ cd e1000e-repo/
$ cp -r /path/to/e1000e/ .
$ svn add e1000e
$ svn commit

"svn add" adds the files to your local checked-out copy of the repository. "svn commit" commits the changes in your local repository to the main repository. You will be prompted for your CSC proxy password each time you access the main repository. At this point, you have successfully setup your repository. Your partner can use svn checkout https://svn.iitd.ernet.in/~cs1012345/e1000e-repo to checkout a copy of the code. Just like you, your partner is also authorized to make changes and commit them to the main repository.

If this does not work, carefully study the instructions given at the CSC Webpage on creating, accessing, and securing your repositories. Report any missing instructions that you find to the course staff so that we can fix the documentation.

Here are some more useful commands:

svn status
Show the status of each file (whether added to the repository or not).
svn add
Add a file to the local repository. You need to do this for any new file that you create since the last update. Do this for files which shows "?" in the status command and which you would like to add to the repository.
svn delete
Delete a file from the local repository.
svn update
Update the local repository with the contents of the main repository if they have changed since the last commit. It is possible that this command reports certain conflicts as your partner's changes may conflict with your changes. You will need to fix these conflicts manually.
svn commit
Reflect the changes in your local repository to the main repository. You may have to do svn update before this if your partner has committed some changes after your last update. If some of your changes conflict with your partner's changes, you may have to resolve them manually and then use svn resolved filename.
svn log https://svn.iitd.ernet.in/~cs1012345/e1000e-repo
To see the commit log
svn help [status|add|update|commit]
Get help

Version Control Software is used in almost all modern software development environments. Read this wikipedia article to know more about the theory. Here is a brief tutorial by the Computer Services Center on using the IITD Subversion repository. Here is a quick start document for basic SVN commands.