Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

README is too big #51

Open
davvore33 opened this issue Sep 21, 2017 · 1 comment
Open

README is too big #51

davvore33 opened this issue Sep 21, 2017 · 1 comment
Assignees

Comments

@davvore33
Copy link
Collaborator

Write a more clear and structured documentation that helps users and developers also through the code

@dceara dceara changed the title README it's too big README is too big Sep 21, 2017
@davvore33
Copy link
Collaborator Author

davvore33 commented Sep 27, 2017

Here are a couple of doc generators that we could use:

  • Sphinx: it gives a nice HTML output (e.g.) and LaTeX (PDF) (can be used also with C/C++)
  • Doxygen: classic , already used in dpdk lib

davvore33 added a commit that referenced this issue Nov 16, 2018
Issue: #51

2018-11-15 17:20:18,030 - TestPerf - INFO - Test test_01_4M_tcp_sess_setup_rate
2018-11-15 17:21:41,942 - TestPerf - INFO - Average Rate 9110042
2018-11-15 17:21:41,942 - TestPerf - INFO - Test test_02_8M_tcp_sess_setup_rate
2018-11-15 17:24:12,586 - TestPerf - INFO - Average Rate 8867311
2018-11-15 17:24:12,586 - TestPerf - INFO - Test test_03_10M_tcp_sess_setup_rate
2018-11-15 17:27:16,993 - TestPerf - INFO - Average Rate 8781586
2018-11-15 17:27:16,993 - TestPerf - INFO - Test test_04_4M_tcp_sess_data_10b_setup_rate
2018-11-15 17:28:52,593 - TestPerf - INFO - Average Rate 3750458
2018-11-15 17:28:52,593 - TestPerf - INFO - Test test_05_4M_tcp_sess_data_1024b_setup_rate
2018-11-15 17:30:28,119 - TestPerf - INFO - Average Rate 2729779
2018-11-15 17:30:28,119 - TestPerf - INFO - Test test_06_4M_tcp_sess_data_1300b_setup_rate
2018-11-15 17:32:03,736 - TestPerf - INFO - Average Rate 3698906
2018-11-15 17:32:03,736 - TestPerf - INFO - Test test_07_4M_udp_sess_data_10b_setup_rate
2018-11-15 17:33:24,620 - TestPerf - INFO - Average Rate 11529864
2018-11-15 17:33:24,620 - TestPerf - INFO - Test test_08_4M_http_sess_data_10b_setup_rate
2018-11-15 17:34:58,660 - TestPerf - INFO - Average Rate 3321408
2018-11-15 17:34:58,660 - TestPerf - INFO - Test test_09_4M_udp_mcast_flows_data_10b_setup_rate
2018-11-15 17:36:21,266 - TestPerf - INFO - Average Rate 22423733
2018-11-15 17:36:21,266 - TestPerf - INFO - Test test_10_timestamp_4M_tcp_sess_setup_rate
2018-11-15 17:37:52,894 - TestPerf - INFO - Average Rate 7839322
2018-11-15 17:37:52,894 - TestPerf - INFO - Test test_11_timestamp_4M_udp_sess_data_10b_setup_rate
2018-11-15 17:39:16,956 - TestPerf - INFO - Average Rate 10923372
2018-11-15 17:39:16,956 - TestPerf - INFO - Test test_12_recent_timestamp_4M_tcp_sess_setup_rate
2018-11-15 17:40:48,576 - TestPerf - INFO - Average Rate 7935660
2018-11-15 17:40:48,576 - TestPerf - INFO - Test test_13_recent_timestamp_4M_udp_sess_data_10b_setup_rate
2018-11-15 17:42:12,339 - TestPerf - INFO - Average Rate 10988846
2018-11-15 17:42:12,339 - TestPerf - INFO - Test test_14_timestamp_raw_4M_tcp_sess_data_1024b_setup_rate
2018-11-15 17:43:47,670 - TestPerf - INFO - Average Rate 2998002
2018-11-15 17:43:47,670 - TestPerf - INFO - Test test_15_timestamp_raw_4M_udp_sess_data_1024b_setup_rate
2018-11-15 17:45:04,200 - TestPerf - INFO - Average Rate 13388961
2018-11-15 17:45:04,201 - TestPerf - INFO - Test test_16_recent_timestamp_raw_4M_tcp_sess_data_1024b_setup_rate
2018-11-15 17:46:39,514 - TestPerf - INFO - Average Rate 2985447
2018-11-15 17:46:39,514 - TestPerf - INFO - Test test_17_recent_timestamp_raw_4M_udp_sess_data_1024b_setup_rate
2018-11-15 17:47:56,045 - TestPerf - INFO - Average Rate 13283162
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

2 participants