Start enforcing macro value limits and make some doc more succinct

Author: Holden

source/FreeRTOS_DNS.c

@@ -492,8 +492,6 @@
         }
     #endif /* if ( ipconfigDNS_USE_CALLBACKS == 0 ) */
 
-    #if ( ipconfigINCLUDE_FULL_INET_ADDR == 1 )
-
 /**
  * @brief See if pcHostName contains a valid IPv4 or IPv6 IP-address.
  * @param[in] pcHostName: The name to be looked up
@@ -502,52 +500,51 @@
  *                            be stored.
  * @return Either 0 or an IP=address.
  */
-        static uint32_t prvPrepare_ReadIPAddress( const char * pcHostName,
-                                                  BaseType_t xFamily,
-                                                  struct freertos_addrinfo ** ppxAddressInfo )
-        {
-            uint32_t ulIPAddress = 0U;
+    static uint32_t prvPrepare_ReadIPAddress( const char * pcHostName,
+                                              BaseType_t xFamily,
+                                              struct freertos_addrinfo ** ppxAddressInfo )
+    {
+        uint32_t ulIPAddress = 0U;
 
-            ( void ) xFamily;
+        ( void ) xFamily;
 
-            /* Check if the hostname given is actually an IP-address. */
-            #if ( ipconfigUSE_IPv6 != 0 )
-                if( xFamily == FREERTOS_AF_INET6 )
-                {
-                    IPv6_Address_t xAddress_IPv6;
-                    BaseType_t xResult;
+        /* Check if the hostname given is actually an IP-address. */
+        #if ( ipconfigUSE_IPv6 != 0 )
+            if( xFamily == FREERTOS_AF_INET6 )
+            {
+                IPv6_Address_t xAddress_IPv6;
+                BaseType_t xResult;
 
-                    /* ulIPAddress does not represent an IPv4 address here. It becomes non-zero when the look-up succeeds. */
-                    xResult = FreeRTOS_inet_pton6( pcHostName, xAddress_IPv6.ucBytes );
+                /* ulIPAddress does not represent an IPv4 address here. It becomes non-zero when the look-up succeeds. */
+                xResult = FreeRTOS_inet_pton6( pcHostName, xAddress_IPv6.ucBytes );
 
-                    if( xResult == 1 )
-                    {
-                        /* This function returns either a valid IPv4 address, or
-                         * in case of an IPv6 lookup, it will return a non-zero */
-                        ulIPAddress = 1U;
+                if( xResult == 1 )
+                {
+                    /* This function returns either a valid IPv4 address, or
+                     * in case of an IPv6 lookup, it will return a non-zero */
+                    ulIPAddress = 1U;
 
-                        if( ppxAddressInfo != NULL )
-                        {
-                            *( ppxAddressInfo ) = pxNew_AddrInfo( pcHostName, FREERTOS_AF_INET6, xAddress_IPv6.ucBytes );
-                        }
+                    if( ppxAddressInfo != NULL )
+                    {
+                        *( ppxAddressInfo ) = pxNew_AddrInfo( pcHostName, FREERTOS_AF_INET6, xAddress_IPv6.ucBytes );
                     }
                 }
-                else
-            #endif /* ipconfigUSE_IPv6 */
-            {
-                ulIPAddress = FreeRTOS_inet_addr( pcHostName );
+            }
+            else
+        #endif /* ipconfigUSE_IPv6 */
+        {
+            ulIPAddress = FreeRTOS_inet_addr( pcHostName );
 
-                if( ( ulIPAddress != 0U ) && ( ppxAddressInfo != NULL ) )
-                {
-                    const uint8_t * ucBytes = ( uint8_t * ) &( ulIPAddress );
+            if( ( ulIPAddress != 0U ) && ( ppxAddressInfo != NULL ) )
+            {
+                const uint8_t * ucBytes = ( uint8_t * ) &( ulIPAddress );
 
-                    *( ppxAddressInfo ) = pxNew_AddrInfo( pcHostName, FREERTOS_AF_INET4, ucBytes );
-                }
+                *( ppxAddressInfo ) = pxNew_AddrInfo( pcHostName, FREERTOS_AF_INET4, ucBytes );
             }
-
-            return ulIPAddress;
         }
-    #endif /* ( ipconfigINCLUDE_FULL_INET_ADDR == 1 ) */
+
+        return ulIPAddress;
+    }
 /*-----------------------------------------------------------*/
 
     #if ( ipconfigDNS_USE_CALLBACKS == 1 )
@@ -622,11 +619,7 @@
         {
             /* If the supplied hostname is an IP address, put it in ppxAddressInfo
              * and return. */
-            #if ( ipconfigINCLUDE_FULL_INET_ADDR == 1 )
-                {
-                    ulIPAddress = prvPrepare_ReadIPAddress( pcHostName, xFamily, ppxAddressInfo );
-                }
-            #endif /* ipconfigINCLUDE_FULL_INET_ADDR == 1 */
+            ulIPAddress = prvPrepare_ReadIPAddress( pcHostName, xFamily, ppxAddressInfo );
 
             /* If a DNS cache is used then check the cache before issuing another DNS
              * request. */

source/include/FreeRTOSIPDeprecatedDefinitions.h

@@ -69,6 +69,10 @@
     #error ipconfigHAS_INLINE_FUNCTIONS is not used
 #endif
 
+#ifdef ipconfigINCLUDE_FULL_INET_ADDR
+    #error ipconfigINCLUDE_FULL_INET_ADDR is not used
+#endif
+
 #ifdef ipconfigMAX_SEND_BLOCK_TIME_TICKS
     #error Now called: ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS
 #endif

source/include/FreeRTOS_DNS_Globals.h

@@ -98,15 +98,6 @@
         #define dnsNBNS_QUERY_RESPONSE_FLAGS    ( 0x8500U )
     #endif /* ( ipconfigUSE_NBNS != 0 ) */
 
-
-    #ifndef _lint
-        #if ( ipconfigUSE_DNS_CACHE == 0 )
-            #if ( ipconfigDNS_CACHE_ADDRESSES_PER_ENTRY != 1 )
-                #error When DNS caching is disabled, please make ipconfigDNS_CACHE_ADDRESSES_PER_ENTRY equal to 1.
-            #endif
-        #endif
-    #endif
-
 /** @brief Define the ASCII value of '.' (Period/Full-stop). */
     #define ASCII_BASELINE_DOT    46U