From 2b62a8c845bec3397ac217567b3d015eb88ecf71 Mon Sep 17 00:00:00 2001 From: Philippe Brais Date: Mon, 1 Jan 2024 16:44:05 -0500 Subject: [PATCH 1/4] Fix typos - Copy doxygen generated text from browser into MS Word and check spelling and grammar suggestions. - Not all suggestions from Word are applied. Keeping changes to minimum. - Only checked "Related Pages" and the "Detailed Description" under "Modules/**". --- BUILDING | 4 ++-- doc/contrib.txt | 4 ++-- doc/doxygen/main_page.h | 6 +++--- src/apps/netbiosns/netbiosns.c | 2 +- src/apps/snmp/snmp_core.c | 4 ++-- src/core/pbuf.c | 2 +- src/core/sys.c | 6 +++--- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/BUILDING b/BUILDING index a2adc626..bbf0edab 100644 --- a/BUILDING +++ b/BUILDING @@ -26,7 +26,7 @@ be linked against application code. not the case. 3) OS/platform port: - Usually the OS port needs to be provided by the user. + Usually, the OS port needs to be provided by the user. If a port to Linux, Windows or MacOS is useful for you, you can use contrib/ports/{win32, unix}/Filelists.cmake @@ -37,7 +37,7 @@ VARIABLES ========= In all cases, you need to provide two variables. -"LWIP_DIR" pointing to the lwIP directory +"LWIP_DIR" pointing to the lwIP directory. Example: set(LWIP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/externals/lwip) diff --git a/doc/contrib.txt b/doc/contrib.txt index 2a44857e..fe885474 100644 --- a/doc/contrib.txt +++ b/doc/contrib.txt @@ -7,7 +7,7 @@ in lwIP development. Here is a short list of suggestions to anybody working with lwIP and trying to contribute bug reports, fixes, enhancements, platform ports etc. -First of all as you may already know lwIP is a volunteer project so feedback +First of all, as you may already know, lwIP is a volunteer project so feedback to fixes or questions might often come late. Hopefully the bug and patch tracking features of Savannah help us not lose users' input. @@ -54,5 +54,5 @@ features of Savannah help us not lose users' input. 2.4 Platform porters: 1. If you have ported lwIP to a platform (an OS, a uC/processor or a combination of these) and - you think it could benefit others[1] you might want discuss this on the mailing list. You + you think it could benefit others[1] you might want to discuss this on the mailing list. You can also ask for Git access to submit and maintain your port in the lwIP/contrib subdir. diff --git a/doc/doxygen/main_page.h b/doc/doxygen/main_page.h index 4766c3a1..21f3068e 100644 --- a/doc/doxygen/main_page.h +++ b/doc/doxygen/main_page.h @@ -80,7 +80,7 @@ * The socket API is a compatibility API for existing applications, * currently it is built on top of the sequential API. It is meant to * provide all functions needed to run socket API applications running - * on other platforms (e.g. unix / windows etc.). However, due to limitations + * on other platforms (e.g. Unix / Windows etc.). However, due to limitations * in the specification of this API, there might be incompatibilities * that require small modifications of existing programs. * @@ -301,7 +301,7 @@ Call these functions in the order of appearance: Registers the default network interface. - netif_set_link_up(struct netif *netif) - This is the hardware link state; e.g. whether cable is plugged for wired + This is the hardware link state, e.g. whether cable is plugged for wired Ethernet interface. This function must be called even if you don't know the current state. Having link up and link down events is optional but DHCP and IPv6 discover benefit well from those events. @@ -367,7 +367,7 @@ Call these functions in the order of appearance: * macro in an application that uses multithreading. lwIP code has * several places where a check for a correct thread context is * implemented which greatly helps the user to get threading done right. - * See the example sys_arch.c files in unix and Win32 port + * See the example sys_arch.c files in Unix and Win32 port * in the lwIP/contrib subdirectory. * * In short: Copy the functions sys_mark_tcpip_thread() and diff --git a/src/apps/netbiosns/netbiosns.c b/src/apps/netbiosns/netbiosns.c index 4b1383e7..a6861ece 100644 --- a/src/apps/netbiosns/netbiosns.c +++ b/src/apps/netbiosns/netbiosns.c @@ -11,7 +11,7 @@ * It responds to name queries for a configurable name. * Name resolving is not supported. * - * Note that the device doesn't broadcast it's own name so can't + * Note that the device doesn't broadcast its own name so can't * detect duplicate names! */ diff --git a/src/apps/snmp/snmp_core.c b/src/apps/snmp/snmp_core.c index fc64c428..5acf1aa8 100644 --- a/src/apps/snmp/snmp_core.c +++ b/src/apps/snmp/snmp_core.c @@ -51,13 +51,13 @@ * Features: * --------- * - SNMPv2c support. - * - SNMPv3 support (a port to ARM mbedtls is provided, LWIP_SNMP_V3_MBEDTLS option). + * - SNMPv3 support (a port to ARM Mbed TLS is provided, LWIP_SNMP_V3_MBEDTLS option). * - Low RAM usage - no memory pools, stack only. * - MIB2 implementation is separated from SNMP stack. * - Support for multiple MIBs (snmp_set_mibs() call) - e.g. for private MIB. * - Simple and generic API for MIB implementation. * - Comfortable node types and helper functions for scalar arrays and tables. - * - Counter64, bit and truthvalue datatype support. + * - Counter64, bit and truth value datatype support. * - Callbacks for SNMP writes e.g. to implement persistency. * - Runs on two APIs: RAW and netconn. * - Async API is gone - the stack now supports netconn API instead, diff --git a/src/core/pbuf.c b/src/core/pbuf.c index 54a6e0e4..b1616be2 100644 --- a/src/core/pbuf.c +++ b/src/core/pbuf.c @@ -30,7 +30,7 @@ * pbuf of a packet has a ->next field other than NULL, more packets * are on the queue. * - * Therefore, looping through a pbuf of a single packet, has an + * Therefore, looping through a pbuf of a single packet, has a * loop end condition (tot_len == p->len), NOT (next == NULL). * * Example of custom pbuf usage: @ref zerocopyrx diff --git a/src/core/sys.c b/src/core/sys.c index 69d7197a..f1fbcdb1 100644 --- a/src/core/sys.c +++ b/src/core/sys.c @@ -106,11 +106,11 @@ * Used to protect short regions of code against concurrent access. * - Your system is a bare-metal system (probably with an RTOS) * and interrupts are under your control: - * Implement this as LockInterrupts() / UnlockInterrupts() + * Implement this as LockInterrupts() / UnlockInterrupts(). * - Your system uses an RTOS with deferred interrupt handling from a - * worker thread: Implement as a global mutex or lock/unlock scheduler + * worker thread: Implement as a global mutex or lock/unlock scheduler. * - Your system uses a high-level OS with e.g. POSIX signals: - * Implement as a global mutex + * Implement as a global mutex. * * @defgroup sys_misc Misc * @ingroup sys_os -- 2.43.0.windows.1