Commit Graph

183 Commits

Author SHA1 Message Date
Nathan Hartman
a5e643b0cd Fix typos in comments and documentation. 2020-03-16 20:01:11 -06:00
Xiang Xiao
cde88cabcc Run codespell -w with the latest dictonary again
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-02-23 22:27:46 +01:00
Gregory Nutt
de45c3f607 Documentation/NuttShell.html: Update to include a description of the 'dmesg' command which was apparently never documented. 2019-11-21 12:25:50 -06:00
Gregory Nutt
a257a5e606 Documentation/NuttShell.html: Update document to at least mention the new pmconfig command. 2019-11-04 08:01:28 -06:00
Gregory Nutt
3439720739 Documentation/NuttShell.html: Document the new -t option for the 'arp' command. 2019-11-03 16:21:51 -06:00
Gregory Nutt
a917f71fa2 Documentation/NuttShell.html: Update to include the new rptun command. 2019-11-03 10:04:50 -06:00
Gregory Nutt
dd97fb991b This commit moves shared builtin information out of binfmt/libbuiltin and into libs/libc/builtin where it can be shared. This should permit builtin application in the PROTECTED build where binfmt/libbuiltin is not available in user space.
Squashed commit of the following:

    Correct some additional compile-related issues.

    Move  include/nuttx/binfmt/builtin.h to include/nuttx/lib/builtin.h.  Move apps/builtin/lib_builtin_forindex.c to libs/libc/builtin/lib_builtin_forindex.c.

    Move binfmt/libbuiltin to libs/libc/builtin.  There are calls made directly from apps/nshlib into this logic and hence, must be part of a library that can be shared between the OS and applications.
2019-08-23 09:07:40 -06:00
Gregory Nutt
74c17076c7 Documentation: Update some documents affected by the change in the organization of the boards/ sub-directory. 2019-08-08 10:05:34 -06:00
Gregory Nutt
615c0ea7ee Change naming configs/ to boards in comments, Documentation, etc. Still a few more to go. 2019-08-05 07:13:48 -06:00
Matias N
272b5b2636 Documentation/: Applies a stylesheet to static HTML files. I've also tried to put the TOC of each document to the side, where it made sense (in some documents the TOC was actually inside a section so it wasn't possible). In some cases the TOC is built with a table, in others with a <ul> element, so I had to acomodate for this. I also didn't go into collapsing, although this could really help for some long TOCs. 2019-05-21 19:13:45 -06:00
Gregory Nutt
b49be4bb20 Squashed commit of the following:
arch/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    sched/ audio/ crypto/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    Documentation/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    fs/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    graphics/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    net/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    drivers/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    include/, syscall/, wireless/:  Removed all references to CONFIG_DISABLE_POLL.  The standard POSIX poll() can not longer be disabled.
    configs/:  Remove all references to CONFIG_DISABLE_POLL.  Standard POSIX poll can no longer be disabled.
2019-05-21 18:57:54 -06:00
Michał Łyszczek
6aac53c6a1 Documentation/NuttShell.html: Command date is misspelled as data in chapter 2.12 Show or set the date and time (date). 2019-05-01 06:52:54 -06:00
Gregory Nutt
abf6965c24 Squashed commit of the following:
libs/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    syscall/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    wireless/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    Documentation/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    include/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    drivers/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    sched/:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    configs:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    arch/xtensa:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    arch/z80:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    arch/x86:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    arch/renesas and arch/risc-v:  Remove references to CONFIG_DISABLE_SIGNALS.  Signals can no longer be disabled.
    arch/or1k:  Remove all references to CONFIG_DISABLE_SIGNALS.  Signals are always enabled.
    arch/misoc:  Remove all references to CONFIG_DISABLE_SIGNALS.  Signals are always enabled.
    arch/mips:  Remove all references to CONFIG_DISABLE_SIGNALS.  Signals are always enabled.
    arch/avr:  Remove all references to CONFIG_DISABLE_SIGNALS.  Signals are always enabled.
    arch/arm:  Remove all references to CONFIG_DISABLE_SIGNALS.  Signals are always enabled.
2019-04-29 14:52:05 -06:00
Gregory Nutt
a64869aa67 CONFIG_NFILE_DESCRIPTORS=0 can no longer be used to disable the file system. NuttX with no file system does not make sense.
Squashed commit of the following:

    configs/:  The few configurations that formerly set CONFIG_NFILE_DESCRIPTORS=0 should not default, rather they should set the number of descriptors to 3.
    fs/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    tools/:  Tools updates for changes to usage of CONFIG_NFILE_DESCRIPTORS.
    syscall/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    libs/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    include/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    drivers/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    Documentation/:  Remove all references to CONFIG_NFILE_DESCRIPTORS == 0
    binfmt/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    arch/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    net/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    sched/:  Remove all conditional logic based on CONFIG_NFILE_DESCRIPTORS == 0
    sched/Kconfig:  CONFIG_NFILE_DESCRIPTORS may no longer to set to a value less than 3
    configs/:  Remove all settings for CONFIG_NFILE_DESCRIPTORS < 3
2019-02-11 12:09:26 -06:00
Gregory Nutt
b35a140636 About the NuttX 'About' document in preparation for the 7.28 release. 2019-01-19 10:31:06 -06:00
Gregory Nutt
300b26d1d8 Documentation/NuttShell.html: Another trivial update. 2018-10-02 13:47:47 -06:00
Gregory Nutt
c1fdd2d6b1 Documentation/NuttShell.html: Trivial correction in comparison to Bash behavior. 2018-10-02 12:14:36 -06:00
Gregory Nutt
4eeba49507 Documentation/NuttShell.html: Add a little more information for the NSH set command. 2018-10-02 11:57:39 -06:00
Gregory Nutt
a90e031028 Documentation/NuttShell.html: Improve an explanation. 2018-10-02 06:52:47 -06:00
Gregory Nutt
c04b9ef7bd Documentation/NuttShell.html: Add description of the PATH environment variable. 2018-10-01 15:09:16 -06:00
Gregory Nutt
1236d194ac Documentation/NuttShell.html: Update document to describe the 'export' command, the CONFIG_NSH_VARS setting, and the effect of this setting on the behavior of the 'set' and 'unset' commands. 2018-10-01 14:30:44 -06:00
Gregory Nutt
4391b51cd3 fs/procfs/fs_procfsproc.c: Change output of the env file so that it looks more like output from the 'env' command. Documentation/NuttShell.html: Document the new NSH 'env' command. 2018-09-30 11:15:28 -06:00
Gregory Nutt
0756cf66ed sched/signal: Add support for SIGINT in addition to SIGKILL. drivers/serial: Use SIGINT instead of SIGKILL when control-C is pressed. 2018-08-28 12:15:31 -06:00
Gregory Nutt
d52561fbef Update NSH documention to describe the optional mode argument to the poweroff and reboot commands. 2018-08-22 17:03:25 -06:00
Gregory Nutt
45e61f1138 Documentation/NuttShell.html: Back out a removed feature. 2018-08-12 06:18:22 -06:00
Gregory Nutt
95e3b9ab8b Documentation/NuttShell.html: Back out part of commit 288a083d91 2018-08-11 10:50:29 -06:00
Gregory Nutt
288a083d91 Documentation/NuttShell.html: Another update to the NSH documentation. 2018-08-11 10:17:38 -06:00
Gregory Nutt
5d791547dd Documentation/NuttShell.html: Document recent changes to NSH. 2018-08-11 08:23:25 -06:00
Alan Carvalho de Assis
283b73edc5 Fix lots of typos in C comments and Kconfig help text 2018-07-08 18:24:45 -06:00
Gregory Nutt
22cd0d47fa This commit attempts remove some long standard confusion in naming and some actual problems that result from the naming confusion. The basic problem is the standard MTU does not include the size of the Ethernet header. For clarity, I changed the naming of most things called MTU to PKTSIZE. For example, CONFIG_NET_ETH_MTU is now CONFIG_NET_ETH_PKTSIZE.
This makes the user interface a little hostile.  People thing of an MTU of 1500 bytes, but the corresponding packet is really 1514 bytes (including the 14 byte Ethernet header).  A more friendly solution would configure the MTU (as before), but then derive the packet buffer size by adding the MAC header length.  Instead, we define the packet buffer size then derive the MTU.

The MTU is not common currency in networking.  On the wire, the only real issue is the MSS which is derived from MTU by subtracting the IP header and TCP header sizes (for the case of TCP).  Now it is derived for the PKTSIZE by subtracting the IP header, the TCP header, and the MAC header sizes.  So we should be all good and without the recurring 14 byte error in MTU's and MSS's.

Squashed commit of the following:

    Trivial update to fix some spacing issues.
    net/: Rename several macros containing _MTU to _PKTSIZE.
    net/: Rename CONFIG_NET_SLIP_MTU to CONFIG_NET_SLIP_PKTSIZE and similarly for CONFIG_NET_TUN_MTU.  These are not the MTU which does not include the size of the link layer header.  These are the full size of the packet buffer memory (minus any GUARD bytes).
    net/: Rename CONFIG_NET_6LOWPAN_MTU to CONFIG_NET_6LOWPAN_PKTSIZE and similarly for CONFIG_NET_TUN_MTU.  These are not the MTU which does not include the size of the link layer header.  These are the full size of the packet buffer memory (minus any GUARD bytes).
    net/: Rename CONFIG_NET_ETH_MTU to CONFIG_NET_ETH_PKTSIZE.  This is not the MTU which does not include the size of the link layer header.  This is the full size of the packet buffer memory (minus any GUARD bytes).
    net/: Rename the file d_mtu in the network driver structure to d_pktsize.  That value saved there is not the MTU.  The packetsize is the memory large enough to hold the maximum packet PLUS the size of the link layer header.  The MTU does not include the link layer header.
2018-07-04 14:10:40 -06:00
Gregory Nutt
5393622d07 Documentation/NuttShell.html: Clarify arguments to the mkrd command. 2018-06-22 11:34:31 -06:00
Gregory Nutt
f11dec3e20 Documentation/NuttShell.html: Document the mkfatfs the -r option which can be used to specify the number of entries in the FAT12/FAT16 root directory. 2018-05-11 09:52:08 -06:00
Gregory Nutt
f12f2c3828 Documentation: Use a little more care with the trademarked Unix name. 2018-05-11 08:15:51 -06:00
Juha Niskanen
8814533e78 Documentation: remove non-existent CONFIG_NSH_TMPDIR from docs 2018-04-17 05:55:57 -06:00
Juha Niskanen
6575480d5e Documentation: Fix some typos. 2018-03-22 06:40:58 -06:00
Gregory Nutt
de8f3ebedb Documentation: Update NSH documention to discuss the irqinfo command. 2018-01-12 18:26:46 -06:00
Gregory Nutt
4fc2980571 Documentation/: Update the NSH user manual to include the echo -n option. 2018-01-10 07:30:37 -06:00
Gregory Nutt
7a2e300890 Documentation: Update NSH manual to include truncate command. 2018-01-04 12:51:01 -06:00
Gregory Nutt
70c59a9d91 This commit adds support for semi-standard IPPROTO_ICMP6 sockets. This is a replacement for the non-standard ICMPv6 ping support that violated the portable POSIX OS interface.
Squashed commit of the following:

    net/icmpv6: IPPROT_ICMP6 socket logic now builds without error.
    net/icmpv6:  Add support for read-ahead and poll(). Initial commit is just cloned from ICMP with the appropriate name changes.
    configs/:  All defconfig filess that include CONFIG_NET_ICMPv6_SOCKET=y need to select CONFIG_SYSTEM_PING6=y and deselect CONFIG_DISABLE_POLL.
    Update NSH documention to show that ping6 is now a built in command.
    net/icmpv6:  Add icmpv6_sendto.c and icmpv6_recvfrom.c.  Initial versions are just clones from icmp/ with appropriate name changes.
    net/icmpv6:  Clone some ICMP socket logic as the beginning of support for ICMPv6 socket support.
    Rename CONFIG_NET_ICMPv6_PING to CONFIG_NET_ICMPv6_SOCKET.  Move prototype for icmpv6_ping from include/nuttx/net/icmpv6 to net/icmpv6/icmpv6.h
2017-10-24 11:23:08 -06:00
Gregory Nutt
261045e689 Update NSH documentation. 2017-10-23 09:23:11 -06:00
Gregory Nutt
cccc86da09 This change adds support for semi-standard IPPROTO_ICMP AF_INET datagram sockets. This replaces the old ad hoc, nonstandard way of implementing ping with a more standard, socket interface.
Squashed commit of the following:

    net/icmp:  Finishes off icmp_recvfrom().
    net/icmp:  Add readahead support for IPPROTO_ICMP sockets.
    net/icmp:  Add poll() support for IPPROTO_ICMP sockets.
    net/icmp:  Add a connection structure for IPPROTO_ICMP sockets.
    net/icmp:  Implements sendto for the IPPROTO_ICMP socket.
    net/icmp:  Move icmp_sendto() and icmp_recvfrom() to separate files.  They are likely to be complex (when they are implemented).
    net/icmp:  Hook IPPROTO_ICMP sockets into network.  Fix some naming collisions.  Still missing basic ICMP send/receive logic.
    configs: apps/system/ping current need poll() enabled.
    configs: All defconfig files that use to enable low-level support must now enabled CONFIG_SYSTEM_PING.
    net/icmp:  Adds basic build framework to support IPPROTO_ICMP sockets.
2017-10-23 08:45:12 -06:00
Gregory Nutt
9b31a81b00 Squashed commit of the following:
fs/fat:  Remove mkfatfs from the OS.  This is a user-space application and belongs in apps, not in the OS.
2017-10-20 12:36:25 -06:00
Gregory Nutt
cbf247e11b Update NSH documentation. 2017-08-11 15:56:33 -06:00
Gregory Nutt
5a352cacc1 Update NSH documentation to show new usage for addroute and delroute. 2017-08-10 10:32:09 -06:00
Gregory Nutt
5cb3edb552 Update some naming used in Documentation 2017-07-02 11:27:27 -06:00
Gregory Nutt
a469f0ef04 Documentation/: Remove dangling space at the end of lines. 2017-06-28 13:27:10 -06:00
Gregory Nutt
492c53c3ff Update NSH documentation. 2017-06-26 17:58:29 -06:00
Gregory Nutt
466fccc494 NSH Documentation: A justification for 3 ENTERs when using USB serial console. 2017-06-13 17:40:05 -06:00
Juha Niskanen
9120a78ee3 Documentation: add hexdump args, fix ln cmd, STM32L status, typos 2017-06-06 06:41:17 -06:00
David Sidrane
0de787b558 Document set [{+|-}{e|x|xe|ex}] [<name> <value>] 2017-04-05 18:28:54 -06:00