Changeset d01dead in rtems-docs

Timestamp:

01/16/16 23:24:08 (7 years ago)

Author:

Amar Takhar <verm@…>

Branches:

4.11, 5, am, master

Children:

ca49bfd

Parents:

75a59fd

git-author:

Amar Takhar <verm@…> (01/16/16 23:24:08)

git-committer:

Amar Takhar <verm@…> (05/03/16 00:51:23)

Message:

Fix markup

File:

• networking/networking.rst (modified) (17 diffs)

networking/networking.rst

@@ -286 +286 @@
 This is equivalent to the following list of definitions.  Early versions
 of the RTEMS BSD network stack required that all of these be defined.
+
 .. code:: c
 
@@ -460 +461 @@
 
 ``SIOCSIFADDR``
+
     If the device is an Ethernet interface these
     commands should be passed on to ``ether_ioctl``.
 
 ``SIOCSIFFLAGS``
+
     This command should be used to start or stop the device,
     depending on the state of the interface ``IFF_UP`` and``IFF_RUNNING`` bits in ``if_flags``:
+
     ``IFF_RUNNING``
+
         Stop the device.
+
     ``IFF_UP``
+
         Start the device.
+
     ``IFF_UP|IFF_RUNNING``
+
         Stop then start the device.
+
     ``0``
+
         Do nothing.
 
@@ -604 +615 @@
 
 ``struct rtems_bsdnet_ifconfig \*ifconfig``
+
     A pointer to the first configuration structure of the first network
     device.  This structure is described in the following section.
@@ -609 +621 @@
 
 ``void (\*bootp)(void)``
+
     This entry should be set to ``rtems_bsdnet_do_bootp`` if your
     application by default uses the BOOTP/DHCP client protocol to obtain
@@ -687 +700 @@
 
 ``unsigned long udp_tx_buf_size``
+
     This configuration parameter specifies the maximum amount of
     buffer memory which may be used for UDP sockets to transmit
@@ -693 +707 @@
 
 ``unsigned long udp_rx_buf_size``
+
     This configuration parameter specifies the maximum amount of
     buffer memory which may be used for UDP sockets to receive
     into.  The default size is the following length in bytes:
+
     .. code:: c
+
         40 * (1024 + sizeof(struct sockaddr_in)
 
 ``unsigned long tcp_tx_buf_size``
+
     This configuration parameter specifies the maximum amount of
     buffer memory which may be used for TCP sockets to transmit
@@ -705 +723 @@
 
 ``unsigned long tcp_rx_buf_size``
+
     This configuration parameter specifies the maximum amount of
     buffer memory which may be used for TCP sockets to receive
@@ -710 +729 @@
 
 ``const cpu_set_t \*network_task_cpuset``
+
     This configuration parameter specifies the CPU affinity of the
     network task. If set to ``0`` the network task can be scheduled on
@@ -715 +735 @@
 
 ``size_t network_task_cpuset_size``
+
     This configuration parameter specifies the size of the``network_task_cpuset`` used. Only available in SMP configurations.
 
@@ -847 +868 @@
   For example the following functions return a pointer to a static
   buffer which remains valid only until the next call:
+
   ``gethostbyaddr``
+
   ``gethostbyname``
+
   ``inet_ntoa``
+
       (``inet_ntop`` is thread-safe, though).
 
@@ -1409 +1434 @@
   This command shows the current routing information for the TCP/IP stack. Following is an
   example showing the output of this command.
+
   .. code:: c
+
       Destination     Gateway/Mask/Hw    Flags     Refs     Use Expire Interface
       10.0.0.0        255.0.0.0          U           0        0     17 smc1
       127.0.0.1       127.0.0.1          UH          0        0      0 lo0
+
   In this example, there is only one network interface with an IP address of 10.8.1.1.  This
   link is currently not up.
@@ -1421 +1449 @@
   URL: (http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-routing.html)
   For a quick reference to the flags, see the table below:
+
   ‘``U``’
       Up: The route is active.
+
   ‘``H``’
       Host: The route destination is a single host.
+
   ‘``G``’
       Gateway: Send anything for this destination on to this remote system, which
       will figure out from there where to send it.
+
   ‘``S``’
       Static: This route was configured manually, not automatically generated by the
       system.
+
   ‘``C``’
       Clone: Generates a new route based upon this route for machines we connect
       to. This type of route is normally used for local networks.
+
   ‘``W``’
       WasCloned: Indicated a route that was auto-configured based upon a local area
       network (Clone) route.
+
   ‘``L``’
       Link: Route involves references to Ethernet hardware.
 
 - ``mbuf``
+
   This command shows the current MBUF statistics.  An example of the command is shown below:
+
   .. code:: c
+
       ************ MBUF STATISTICS \************
       mbufs:4096    clusters: 256    free: 241
@@ -1452 +1490 @@
 
 - ``if``
+
   This command shows the current statistics for your Ethernet driver as long as the ioctl hook``SIO_RTEMS_SHOW_STATS`` has been implemented.  Below is an example:
+
   .. code:: c
+
       ************ INTERFACE STATISTICS \************
       \***** smc1 \*****
@@ -1568 +1609 @@
 - Display the driver statistics (Console ‘``s``’ command or telnet
   ‘control-G’ character) and verify that:
+
   # The number of transmit interrupts is non-zero.
     This indicates that all transmit descriptors have been in use at some time.
+
   # The number of missed packets is non-zero.
     This indicates that all receive descriptors have been in use at some time.
@@ -1605 +1648 @@
   found in the ``ttcp_orig`` subdirectory.
 
-# On the host run ``ttcp -s -t <<insert the hostname or IP address of
-  the Target here>>``
+# On the host run ``ttcp -s -t <<insert the hostname or IP address of  the Target here>>``
 
 The procedure for testing throughput from an RTEMS target
@@ -1615 +1657 @@
 # Download and start the ttcp program on the Target.
 
-# In response to the ``ttcp`` prompt, enter ``-s -t <<insert
-  the hostname or IP address of the Target here>>``.  You need to type the
+# In response to the ``ttcp`` prompt, enter ``-s -t <<insert  the hostname or IP address of the Target here>>``.  You need to type the
   IP address of the host unless your Target is talking to your Domain Name
   Server.
@@ -1981 +2022 @@
 DFE500-TX.
 
-- ```` *[DEC21140 Hardware Manual] DIGITAL, *DIGITAL
+- *[DEC21140 Hardware Manual] DIGITAL, *DIGITAL
   Semiconductor 21140A PCI Fast Ethernet LAN Controller - Hardware
   Reference Manual**.
 
-- ```` *[99.TA.0021.M.ER]Emmanuel Raguet,*RTEMS Cache Management For Intel**.
+- *[99.TA.0021.M.ER]Emmanuel Raguet,*RTEMS Cache Management For Intel**.
 
 Command and Variable Index