docs: added README.md
[dabba.git] / CODING
blob3fec399e26f1b4b8ec1c7781fd6a3315250291f4
1 Roadmap
2 =======
4 1. Thread scheduling tuning
5 2. Zero-copy TX ring
6 3. Traffic generation
7 4. BPF support
8 5. PCAP read
9 6. PCAP file rolling
10 7. Scatter-Gather I/O
12 Present features
13 ================
15  - Zero-copy RX ring
16  - Multithreading
17  - Thread Management
18  - PCAP write/validation support
20 Feature implementation
21 ======================
23 Each feature will developed in its own branch.
25 Its implementation must follow this order:
26  - Coding the actual implementation
27  - Coding test cases which will cover this specific feature
28  - Doxygen based documentation
30 After the feature is stabilized, it will merged back on the master branch.
31 Each feature will bring its own set of test cases to check the stability
32 status and to provide a quick way to perform regression tests.
34 When the desired set of feature a implemented and merged back to the master
35 branch, a tag will be created which can be then released.
37 Coding style
38 ============
40 C source code and header file must be indent using
41 indent -linux
43 Resources
44 =========
46 The whole project management will be based on GitHub.
47 It regroups wiki, ticket system, code review and
48 statistics.
50 A mirror of the project can be found on repo.or.cz.