Skip to content

Fix typos in documentation #1099

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
hamidzr wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Fix typos in documentation #1099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/F-Stack_API_Reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ However, it is supported only before F-Stack is started.
​
int mt_tcpsendrcv(struct sockaddr_in* dst, void* pkg, int len, void* rcv_buf, int& buf_size, int timeout, MtFuncTcpMsgLen chek_func);

Use connection pool to send and recv tcp packet, keep-alive default are 10 mintues. The parameter of buf can't use `static`.
Use connection pool to send and recv tcp packet, keep-alive default are 10 minutes. The parameter of buf can't use `static`.
​

enum MT_TCP_CONN_TYPE
Expand All @@ -221,7 +221,7 @@ However, it is supported only before F-Stack is started.
int mt_tcpsendrcv(struct sockaddr_in* dst, void* pkg, int len, void*& rcv_buf, int& recv_pkg_size, int timeout, MtFuncTcpMsgChecker check_func, void* msg_ctx=NULL, bool keep_rcv_buf=false);


Use connection pool to send and recv tcp packet, keep-alive default are 10 mintues. The parameter of buf can't use `static`.
Use connection pool to send and recv tcp packet, keep-alive default are 10 minutes. The parameter of buf can't use `static`.

#### Socket API for micro threads

Expand All @@ -235,7 +235,7 @@ However, it is supported only before F-Stack is started.

void ff_regist_packet_dispatcher(dispatch_func_t func);

Regist a packet dispath function.
Regist a packet dispatch function.

#### param

Expand Down
2 changes: 1 addition & 1 deletion doc/F-Stack_Development_Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Applications with stateful(high latency) use F-Stack , state need to be stored f

## F-Stack configure file reference

DPDK related parameters, including coremask adn NIC ports num.
DPDK related parameters, including coremask and NIC ports num.
FreeBSD related parameters, similar with original FreeBSD's /boot.config and /etc/sysctl.conf.

## Start a F-Stack application
Expand Down
8 changes: 4 additions & 4 deletions doc/F-Stack_Roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Previously expired Roadmap.
- The minimum timeout unit for epoll_wati in interrupt mode is 1ms, which is not suitable for F-Stack and is therefore abandoned.
- You can config idle_sleep to instead of interrupt mode, and the difference in effect is very small.
2. Run as a network daemon. done.
- Alread support >= F-Stack-1.23.
3. ~~SPDK supportted.~~
- Already support >= F-Stack-1.23.
3. ~~SPDK supported.~~
4. Encapsulate Cyptodev API(Intel QAT). done.
- Alread support >= F-Stack-1.24‘s Nginx, bug you need merge yourself [QAT's pr](https://github.com/intel/QAT_Engine/pull/316).
- Already support >= F-Stack-1.24‘s Nginx, bug you need merge yourself [QAT's pr](https://github.com/intel/QAT_Engine/pull/316).
5. HTTP3(QUIC) support. done.
- Alread support >= F-Stack-1.23's Nginx.
- Already support >= F-Stack-1.23's Nginx.