Merge PR #534 (documentation fixups) into next

snabbco · Jul 1, 2015 · 85d3bb9 · 85d3bb9
2 parents 32f74ee + 269d4a8
commit 85d3bb9
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 15 deletions.
diff --git a/src/apps/.images/Buzz.png → src/apps/basic/.images/Buzz.png b/src/apps/.images/Buzz.png → src/apps/basic/.images/Buzz.png
diff --git a/src/apps/.images/Join.png → src/apps/basic/.images/Join.png b/src/apps/.images/Join.png → src/apps/basic/.images/Join.png
diff --git a/src/apps/.images/Repeater.png → src/apps/basic/.images/Repeater.png b/src/apps/.images/Repeater.png → src/apps/basic/.images/Repeater.png
diff --git a/src/apps/.images/Sink.png → src/apps/basic/.images/Sink.png b/src/apps/.images/Sink.png → src/apps/basic/.images/Sink.png
diff --git a/src/apps/.images/Source.png → src/apps/basic/.images/Source.png b/src/apps/.images/Source.png → src/apps/basic/.images/Source.png
diff --git a/src/apps/.images/Split.png → src/apps/basic/.images/Split.png b/src/apps/.images/Split.png → src/apps/basic/.images/Split.png
diff --git a/src/apps/.images/Tee.png → src/apps/basic/.images/Tee.png b/src/apps/.images/Tee.png → src/apps/basic/.images/Tee.png
diff --git a/src/apps/README.md → src/apps/basic/README.md b/src/apps/README.md → src/apps/basic/README.md
diff --git a/src/apps/README.md.src → src/apps/basic/README.md.src b/src/apps/README.md.src → src/apps/basic/README.md.src
diff --git a/src/apps/packet_filter/README.md b/src/apps/packet_filter/README.md
@@ -24,7 +24,7 @@ expression.
 
 — Key **state_table**
 
-*Optional*. A string naming a state table. If set, packets passing any*
-*rule will be tracked in the specified state table and any packet that
-*belongs to a tracked connection in the specified state table will be let
-*pass.
+*Optional*. A string naming a state table. If set, packets passing any
+*rule* will be tracked in the specified state table and any packet that
+belongs to a tracked connection in the specified state table will be let
+pass.
diff --git a/src/apps/packet_filter/README.md.src b/src/apps/packet_filter/README.md.src
@@ -29,7 +29,7 @@ expression.
 
 — Key **state_table**
 
-*Optional*. A string naming a state table. If set, packets passing any*
-*rule will be tracked in the specified state table and any packet that
-*belongs to a tracked connection in the specified state table will be let
-*pass.
+*Optional*. A string naming a state table. If set, packets passing any
+*rule* will be tracked in the specified state table and any packet that
+belongs to a tracked connection in the specified state table will be let
+pass.
diff --git a/src/doc/genbook.sh b/src/doc/genbook.sh
@@ -31,7 +31,7 @@ order to help improve this document.*
 
 $(cat ../README.md)
 
-$(cat ../apps/README.md)
+$(cat ../apps/basic/README.md)
 
 $(cat ../apps/intel/README.md)
 

diff --git a/src/program/snabbnfv/README.md b/src/program/snabbnfv/README.md
@@ -71,8 +71,8 @@ every second).
 
 The `snabbnfv neutron2snabb` program converts Neutron database CSV dumps
 to the format used by `program.snabbnfv.nfvconfig`. For more info see
-[Snabb NFV Architecture](https://github.com/SnabbCo/snabb-nfv/wiki/Architecture).
-It can be invoked like so:
+[Snabb NFV Architecture](doc/architecture.md).  It can be invoked like
+so:
 
 ```
 ./snabb snabbnfv neutron2snabb <csv-directory> <output-directory> [<hostname>]
@@ -81,4 +81,4 @@ It can be invoked like so:
 `snabbnfv neutron2snabb` reads the Neutron configuration *csv-directory*
 and translates them to one `lib.nfv.conig` configuration file per
 physical network. If *hostname* is given, it overrides the hostname
-provided by `hostname.1`.
+provided by `hostname(1)`.
diff --git a/src/program/snabbnfv/README.md.src b/src/program/snabbnfv/README.md.src
@@ -84,8 +84,8 @@ every second).
 
 The `snabbnfv neutron2snabb` program converts Neutron database CSV dumps
 to the format used by `program.snabbnfv.nfvconfig`. For more info see
-[Snabb NFV Architecture](https://github.com/SnabbCo/snabb-nfv/wiki/Architecture).
-It can be invoked like so:
+[Snabb NFV Architecture](doc/architecture.md).  It can be invoked like
+so:
 
 ```
 ./snabb snabbnfv neutron2snabb <csv-directory> <output-directory> [<hostname>]
@@ -94,4 +94,4 @@ It can be invoked like so:
 `snabbnfv neutron2snabb` reads the Neutron configuration *csv-directory*
 and translates them to one `lib.nfv.conig` configuration file per
 physical network. If *hostname* is given, it overrides the hostname
-provided by `hostname.1`.
+provided by `hostname(1)`.