Skip to content

Commit

Permalink
Merge PR #887 (v2016.04.1 bugfix release) into master
Browse files Browse the repository at this point in the history
  • Loading branch information
eugeneia committed Apr 20, 2016
2 parents 03f5958 + ed2e399 commit 38d4585
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Snabb Switch
# Snabb

Snabb Switch is a simple and fast packet networking toolkit.
Snabb (formerly "Snabb Switch") is a simple and fast packet networking toolkit.

We are also a grassroots community of programmers and network
engineers who help each other to build and deploy new network
elements. We care about practical applications and finding simpler
ways to do things.

The Snabb Switch community are active in
The Snabb community are active in
[applying modern programming techniques](http://blog.ipspace.net/2014/09/snabb-switch-deep-dive-on-software-gone.html),
[do-it-yourself operator networking](http://blog.ipspace.net/2014/12/l2vpn-over-ipv6-with-snabb-switch-on.html),
[high-level device drivers](https://github.com/SnabbCo/snabbswitch/blob/master/src/apps/intel/intel10g.lua),
Expand All @@ -24,21 +24,21 @@ on.

## How does it work?

Snabb Switch is written using these main techniques:
Snabb is written using these main techniques:

- Lua, a high-level programming language that is easy to learn.
- LuaJIT, a just-in-time compiler that is competitive with C.
- Ethernet I/O with no kernel overhead ("kernel bypass" mode).

Snabb Switch compiles into a stand-alone executable called
Snabb compiles into a stand-alone executable called
`snabb`. This single binary includes multiple applications and runs on
any modern Linux distribution. (You could think of it as a
[busybox](http://en.wikipedia.org/wiki/BusyBox#Single_binary) for
networking.)

## How is it being used?

The first generation of Snabb Switch applications include:
The first generation of Snabb applications include:

### snabbnfv

Expand Down Expand Up @@ -84,13 +84,13 @@ or even directly on a Device Under Test.
### snsh

[snsh](src/program/snsh/) (Snabb Shell) is a tool for interactively
experimenting with Snabb Switch. It provides direct access to all APIs
experimenting with Snabb. It provides direct access to all APIs
using a Lua shell. You can operate snsh either from script files or
from an interactive shell.

## How do I get started?

Setting up a Snabb Switch development environment takes around one
Setting up a Snabb development environment takes around one
minute:

```
Expand All @@ -114,7 +114,7 @@ $ sudo snabb packetblaster replay capture.pcap 01:00.0

Here are the ways you can get involved:

- Use the Snabb Switch applications in your network.
- Use the Snabb applications in your network.
- Join the [snabb-devel mailing list](https://groups.google.com/forum/#!forum/snabb-devel).
- Send a mail to [introduce yourself](https://groups.google.com/forum/#!searchin/snabb-devel/introduce/snabb-devel/d8t6hGClnQY/flztyLiIGzoJ) to the community (don't be shy!).
- Create your very own application: [Getting Started](src/doc/getting-started.md).
Expand Down
6 changes: 3 additions & 3 deletions src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -187,15 +187,15 @@ obj/doc/snabb.markdown: markdown Makefile doc/genbook.sh

obj/doc/snabb.pdf: obj/doc/snabb.markdown
$(E) "PANDOC $@"
$(Q) (cd doc; pandoc --template=template.latex --latex-engine=lualatex -V fontsize=10pt -V monofont=droidsansmono -V monoscale=.70 -V verbatimspacing=.85 -V mainfont=droidserif -V sansfont=droidsans -V documentclass:book -V geometry:top=1.0in -V geometry:bottom=0.75in -S --toc --chapters -o ../$@ ../$<)
$(Q) (cd obj/doc; pandoc --template=template.latex --latex-engine=lualatex -V fontsize=10pt -V monofont=droidsansmono -V monoscale=.70 -V verbatimspacing=.85 -V mainfont=droidserif -V sansfont=droidsans -V documentclass:book -V geometry:top=1.0in -V geometry:bottom=0.75in -S --toc --chapters -o ../../$@ ../../$<)

obj/doc/snabb.html: obj/doc/snabb.markdown
$(E) "PANDOC $@"
$(Q) (cd doc; pandoc --self-contained --css="style.css" -S -s --toc --chapters -o ../$@ ../$<)
$(Q) (cd obj/doc; pandoc --self-contained --css="../../doc/style.css" -S -s --toc --chapters -o ../../$@ ../../$<)

obj/doc/snabb.epub: obj/doc/snabb.markdown
$(E) "PANDOC $@"
$(Q) (cd doc; pandoc --self-contained --css="style.css" -S -s --toc --chapters -o ../$@ ../$<)
$(Q) (cd obj/doc; pandoc --self-contained --css="../../doc/style.css" -S -s --toc --chapters -o ../../$@ ../../$<)

CLEAN = snabb obj bin testlog programs.inc

Expand Down
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ecosystem to match your requirements.

| | |
+-----*-----*-----*-----+
| Snabb Core |
| Snabb Core |
+-----------------------+

The Snabb Core forms a runtime environment (*engine*) which
Expand Down
8 changes: 4 additions & 4 deletions src/doc/genbook.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
# The authors list is automatically generated from Git history,
# ordered from most to least commits.

# Root directory for markdown files
mdroot=../obj

# Link images in local .images/
for png in $(find .. -name "*.png"); do
ln -f -s ../$png .images/
ln -s ../../$png $mdroot/doc/.images/
done

# Root directory for markdown files
mdroot=../obj

cat <<EOF
% Snabb Reference Manual
% $(git log --pretty=format:%an | \
Expand Down
1 change: 1 addition & 0 deletions src/scripts/snabb_doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ function build_doc1 {
}
function build_doc {
(cd $(repo_path) && make clean)
out=$(build_doc1 $1 $2 2>&1)
if [ "$?" != 0 ]; then
echo "$out" > $2
Expand Down

0 comments on commit 38d4585

Please sign in to comment.