git: do not track vim swo temp file.
[dabba.git] / CODING
blob877245980b533d360333e87efd6fd6364b88cc19
1 Roadmap
2 =======
4 1. Traffic generation
5 2. PCAP file rolling
6 3. Scatter-Gather I/O
8 Present features
9 ================
11  - Zero-copy RX/TX ring
12  - Multithreading
13  - Thread Management
14  - Thread scheduling tuning
15  - PCAP read/write/validation support
16  - Replay traffic PCAP files
17  - BPF support
19 Feature implementation
20 ======================
22 Each feature will developed in its own branch.
24 Its implementation must follow this order:
25  - Coding the actual implementation
26  - Coding test cases which will cover this specific feature
27  - Doxygen based documentation
29 After the feature is stabilized, it will merged back on the master branch.
30 Each feature will bring its own set of test cases to check the stability
31 status and to provide a quick way to perform regression tests.
33 When the desired set of feature a implemented and merged back to the master
34 branch, a tag will be created which can be then released.
36 Coding style
37 ============
39 C source code and header file must be indent using
40 indent -linux
42 Resources
43 =========
45 The whole project management will be based on GitHub.
46 It regroups wiki, ticket system, code review and
47 statistics.
49 A mirror of the project can be found on repo.or.cz.