Merge pull request #435 from eugeneia/documentation-fixes-amendment

Documentation fixes amendments
snabbco · Apr 1, 2015 · 7fbd27c · 7fbd27c
2 parents c4f5776 + b9a47d6
commit 7fbd27c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 10 deletions.
diff --git a/src/apps/solarflare/README.md b/src/apps/solarflare/README.md
@@ -3,8 +3,11 @@
 ## Solarflare (apps.solarflare.solarflare)
 
 The `Solarflare` app drives one port of a Solarflare SFN7 Ethernet
-controller.  Packets taken from the `rx` port are transmitted onto the
-network.  Packets received from the network are put on the `tx` port.
+controller. Multiple instances of the Solarflare app can be instantiated
+on the same PCI device. Packets received from the network will be
+dispatched between apps based on destination MAC address and VLAN.
+Packets taken from the `rx` port are transmitted onto the network.
+Packets received from the network are put on the `tx` port.
 
 ![Solarflare](.images/Solarflare.png)
 

diff --git a/src/apps/solarflare/README.md.src b/src/apps/solarflare/README.md.src
@@ -3,8 +3,11 @@
 ## Solarflare (apps.solarflare.solarflare)
 
 The `Solarflare` app drives one port of a Solarflare SFN7 Ethernet
-controller.  Packets taken from the `rx` port are transmitted onto the
-network.  Packets received from the network are put on the `tx` port.
+controller. Multiple instances of the Solarflare app can be instantiated
+on the same PCI device. Packets received from the network will be
+dispatched between apps based on destination MAC address and VLAN.
+Packets taken from the `rx` port are transmitted onto the network.
+Packets received from the network are put on the `tx` port.
 
     DIAGRAM: Solarflare
               +------------+

diff --git a/src/lib/protocol/README.md b/src/lib/protocol/README.md
@@ -741,6 +741,4 @@ Combined payload accessor and setter method. Returns a pointer to the
 datagram payload and its byte size.
 
 If *pointer* and *length* are supplied then *length* bytes starting from
-*pointer* are appended to the datagram's payload. The caller has to
-ensure that the underlying packet has enough free space to accommodate
-for *length* additional bytes.
+*pointer* are appended to the datagram's payload.
diff --git a/src/lib/protocol/README.md.src b/src/lib/protocol/README.md.src
@@ -754,6 +754,4 @@ Combined payload accessor and setter method. Returns a pointer to the
 datagram payload and its byte size.
 
 If *pointer* and *length* are supplied then *length* bytes starting from
-*pointer* are appended to the datagram's payload. The caller has to
-ensure that the underlying packet has enough free space to accommodate
-for *length* additional bytes.
+*pointer* are appended to the datagram's payload.