Documentation: various cosmetic changes

This commit is contained in:
raiden00pl
2023-10-29 16:40:32 +01:00
committed by Xiang Xiao
parent 64be5c6958
commit b7f94fbf22
27 changed files with 74 additions and 62 deletions
-1
View File
@@ -13,7 +13,6 @@ NewReno congestion control algorithm is used to solve the problem of network con
Workflow
========
The NewReno on the tcp sender adjusts the cwnd and ssthresh based on received ack and Retransmitted Timeout (RTO) events.
Using the cwnd, together with snd_wnd, controls the number of bytes sent to the network. Here's how newreno works, as following:
@@ -1,5 +1,6 @@
==========================
Task Scheduling Interfaces
**************************
==========================
By default, NuttX performs strict priority scheduling: Tasks of higher
priority have exclusive access to the CPU until they become blocked. At
@@ -29,7 +30,7 @@ compliant interface to the NuttX scheduler:
- :c:func:`sched_get_rr_interval`
Functions
---------
=========
.. c:function:: int sched_setparam(pid_t pid, FAR const struct sched_param *param)
@@ -1,5 +1,6 @@
=================
Clocks and Timers
*****************
=================
- :c:func:`clock_settime`
- :c:func:`clock_gettime`
+2 -1
View File
@@ -1,5 +1,6 @@
=================
Signal Interfaces
*****************
=================
**Tasks and Signals**. NuttX provides signal interfaces for tasks and
pthreads. Signals are used to alter the flow control of tasks by
@@ -1,5 +1,6 @@
========================
Shared Memory Interfaces
************************
========================
Shared memory interfaces are only available with the NuttX kernel build
(``CONFIG_BUILD_KERNEL=y``). These interfaces support user memory
@@ -12,7 +13,7 @@ memory interfaces:
- :c:func:`shmdt`
Functions
---------
=========
.. c:function:: int shmget(key_t key, size_t size, int shmflg)
+5 -4
View File
@@ -1,8 +1,9 @@
==================
OS Data Structures
==================
Scalar Types
************
============
Many of the types used to communicate with NuttX are simple scalar
types. These types are used to provide architecture independence of the
@@ -15,7 +16,7 @@ include:
.. c:type:: time_t
Hidden Interface Structures
***************************
===========================
Several of the types used to interface with NuttX are structures that
are intended to be hidden from the application. From the standpoint of
@@ -33,7 +34,7 @@ specific elements within these hidden structures. These hidden
structures will not be described further in this user's manual.
Access to the ``errno`` Variable
********************************
================================
A pointer to the thread-specific ``errno`` value is available through a
function call:
@@ -61,7 +62,7 @@ function call:
:return: A pointer to the thread-specific ``errno`` value.
User Interface Structures
*************************
=========================
.. c:type:: int (*main_t)(int argc, char *argv[])