Introduction
============
See wrr.lsm


What you will find
==================

  The directory doc/
    Here you will find documentation for the package.
    
    To use the setup from the example directory you will need to read:
    
      intro.txt, install.txt and example.txt
      
    To setup things yourself you should read:
    
      tc.txt, intro.txt, install.txt and wrr.txt
 
    Here is short description of the documents:      
    
      tc.txt:
        This describes the Traffic Control features of the Linux 2.2 kernels
        in general.
	
      intro.txt
        This gives an overview of the WRR scheduler.
	
      install.txt
        This describes how to install the WRR scheduler on your system.
	
      example.txt
        This describes the example setup which can be used when the WRR
	scheduler is installed.
	
      wrr.txt
        This describes the WRR scheduler in detail.

  The directory patch-kernel/ 
    This contains a patch for the kernel.

  The directory patch-iproute2/ 
    This contains a patch for the iproute2 program.

  The directory example/ 
    This contains an example setup.
    

Some comments
=============
Note that the source code is somewhat messy. Also note that there is some
confusing about terminology. For example the terms weight and priority is 
used about the same thing. Decreasing these value is referred to as given 
penalty.


Todo
====
This is a rahter techincal todo list. I will probably not do this:

 * Make it easy to give a machine higher priority than other machines
   and not just lower.
 * Cleanup code and terminologi and use appropriate types and kernel 
   routines for everything.
 * Submit the code for inclusion in the kernel.
 * Make the code keep track of the sum of the priorities of the machines
   which are waiting to transfer data. And when the penaltyfactor is
   negative multiply with this number instead of with the number
   of waiting machines (and document why this is the right way to do it).
 * Split up the module in a filter part and a non-filter part. The filter
   should be able to filter based on arbitary parts of the packet header 
   like the u32 filter.
 * Better support of MAC addressing mode.


Detroduction
============
The author of the WRR scheduler is:

  Christian Worm Mortensen, worm@diku.dk

Please sent bug reports, patches, enhancements, suggestions and comments.
  
The WRR scheduler has a homepage which has the address:

  http://wipl-wrr.sourceforge.net

At this page it is also possible to subscribe to a mailing list for WRR.
An extension which will make WRR coorporate with some proxy servers is
also available.
