From 4de5307aa30ec5e348a8e9002d96fa0901cb2aea Mon Sep 17 00:00:00 2001 From: patacongo Date: Sat, 20 Oct 2012 21:42:19 +0000 Subject: [PATCH] Update documentation for recently added configuration options git-svn-id: http://svn.code.sf.net/p/nuttx/code/trunk@5241 42af7a65-404d-4744-a932-0658087f49c3 --- apps/netutils/resolv/Kconfig | 6 ++-- apps/nshlib/README.txt | 4 +++ nuttx/Documentation/NuttShell.html | 8 +++++ nuttx/Documentation/NuttxPortingGuide.html | 34 ++++++++++++++++++++++ nuttx/configs/README.txt | 21 +++++++++++++ 5 files changed, 70 insertions(+), 3 deletions(-) diff --git a/apps/netutils/resolv/Kconfig b/apps/netutils/resolv/Kconfig index a8e79d6c1f..07a0fd4bca 100644 --- a/apps/netutils/resolv/Kconfig +++ b/apps/netutils/resolv/Kconfig @@ -21,6 +21,6 @@ config NET_RESOLV_MAXRESPONSE default 96 depends on NETUTILS_RESOLV ---help--- - This setting determines the maximum size of DHCP response message that - can be received. The default is 96 but may need to be larger on enterprise - networks (perhaps 176). + This setting determines the maximum size of response message that can be + received by the DNS resolver. The default is 96 but may need to be larger on + enterprise networks (perhaps 176). diff --git a/apps/nshlib/README.txt b/apps/nshlib/README.txt index 0f6aee759b..9f4a88e3e4 100644 --- a/apps/nshlib/README.txt +++ b/apps/nshlib/README.txt @@ -1084,6 +1084,10 @@ NSH-Specific Configuration Settings Set if your ethernet hardware has no built-in MAC address. If set, a bogus MAC will be assigned. + * CONFIG_NSH_MAX_ROUNDTRIP + This is the maximum round trip for a response to a ICMP ECHO request. + It is in units of deciseconds. The default is 20 (2 seconds). + If you use DHCPC, then some special configuration network options are required. These include: diff --git a/nuttx/Documentation/NuttShell.html b/nuttx/Documentation/NuttShell.html index bcf62a5a91..ad204f5dc9 100644 --- a/nuttx/Documentation/NuttShell.html +++ b/nuttx/Documentation/NuttShell.html @@ -2559,6 +2559,13 @@ nsh> If set, a bogus MAC will be assigned. + + CONFIG_NSH_MAX_ROUNDTRIP + + This is the maximum round trip for a response to a ICMP ECHO request. + It is in units of deciseconds. The default is 20 (2 seconds). + +

@@ -3537,6 +3544,7 @@ mount -t vfat /dev/ram1 /tmp

  • CONFIG_NSH_IOBUFFER_SIZE
  • CONFIG_NSH_IPADDR
  • CONFIG_NSH_LINELEN
    • +
  • CONFIG_NSH_MAX_ROUNDTRIP
  • CONFIG_NSH_NESTDEPTH
  • CONFIG_NSH_NETMASK
  • CONFIG_NSH_NOMAC
    • diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html index bf2a0cc4f5..a16032db57 100644 --- a/nuttx/Documentation/NuttxPortingGuide.html +++ b/nuttx/Documentation/NuttxPortingGuide.html @@ -4445,6 +4445,35 @@ build CONFIG_ARCH_BZERO

    +

  • + If CONFIG_ARCH_MEMCPY is not selected, then you make also select Daniel + Vik's optimized implementation of memcpy(): +

    + + +

    + And if CONFIG_MEMCPY_VIK, the following tuning options are available: +

    + +

  • The architecture may provide custom versions of certain standard header files: @@ -5180,6 +5209,11 @@ build

  • CONFIG_NET_RESOLV_ENTRIES: Number of resolver entries
    • +
  • + CONFIG_NET_RESOLV_MAXRESPONSE: + This setting determines the maximum size of response message that can be received by the DNS resolver. + The default is 96 but may need to be larger on enterprise networks (perhaps 176). +

    • THTTPD

    diff --git a/nuttx/configs/README.txt b/nuttx/configs/README.txt index e6bde645d1..cc65540d7f 100644 --- a/nuttx/configs/README.txt +++ b/nuttx/configs/README.txt @@ -621,6 +621,23 @@ defconfig -- This is a configuration file similar to the Linux CONFIG_ARCH_STRNCPY, CONFIG_ARCH_STRLEN, CONFIG_ARCH_STRNLEN CONFIG_ARCH_BZERO + If CONFIG_ARCH_MEMCPY is not selected, then you make also select Daniel + Vik's optimized implementation of memcpy(): + + CONFIG_MEMCPY_VIK - Select this option to use the optimized memcpy() + function by Daniel Vik. See licensing information in the top-level + COPYING file. Default: n + + And if CONFIG_MEMCPY_VIK, the following tuning options are available: + + CONFIG_MEMCPY_PRE_INC_PTRS - Use pre-increment of pointers. Default is + post increment of pointers. + + CONFIG_MEMCPY_INDEXED_COPY - Copying data using array indexing. Using + this option, disables the CONFIG_MEMCPY_PRE_INC_PTRS option. + + CONFIG_MEMCPY_64BIT - Compiles memcpy for 64 bit architectures + The architecture may provide custom versions of certain standard header files: @@ -1078,6 +1095,10 @@ defconfig -- This is a configuration file similar to the Linux CONFIG_NET_DHCP_LIGHT - Reduces size of DHCP CONFIG_NET_RESOLV_ENTRIES - Number of resolver entries + CONFIG_NET_RESOLV_MAXRESPONSE - This setting determines the maximum + size of response message that can be received by the DNS resolver. + The default is 96 but may need to be larger on enterprise networks + (perhaps 176). THTTPD