diff options
author | Thomas Graf <tgraf@noironetworks.com> | 2014-10-28 11:19:52 +0100 |
---|---|---|
committer | Ben Pfaff <blp@nicira.com> | 2014-10-28 08:55:18 -0700 |
commit | 542cc9bb8b8817866afcd692a78fa591db5839dc (patch) | |
tree | b41df76180142279ae927a95df791f6384fad247 /datapath | |
parent | 3aa40c8301b3c2538c18569e2a1e05d500b53392 (diff) | |
download | openvswitch-542cc9bb8b8817866afcd692a78fa591db5839dc.tar.gz |
doc: Convert docs to Markdown language
Converts the majority of docs over to use the Markdown language for
pretty printing on GitHub. It's a rough first convertion without
exploiting the full potential of Markdown at this point. Section
titles and indentation are fixed as needed. Minimal docs interlinking
is added.
Signed-off-by: Thomas Graf <tgraf@noironetworks.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'datapath')
-rw-r--r-- | datapath/Modules.mk | 2 | ||||
-rw-r--r-- | datapath/README.md (renamed from datapath/README) | 50 |
2 files changed, 26 insertions, 26 deletions
diff --git a/datapath/Modules.mk b/datapath/Modules.mk index 90e158cd2..72cb4dcbf 100644 --- a/datapath/Modules.mk +++ b/datapath/Modules.mk @@ -34,7 +34,7 @@ openvswitch_headers = \ vport-netdev.h openvswitch_extras = \ - README + README.md dist_sources = $(foreach module,$(dist_modules),$($(module)_sources)) dist_headers = $(foreach module,$(dist_modules),$($(module)_headers)) diff --git a/datapath/README b/datapath/README.md index 37c20ee24..a8effa354 100644 --- a/datapath/README +++ b/datapath/README.md @@ -41,25 +41,25 @@ flow key that it parsed from the packet. Userspace then extracts its own notion of a flow key from the packet and compares it against the kernel-provided version: - - If userspace's notion of the flow key for the packet matches the - kernel's, then nothing special is necessary. - - - If the kernel's flow key includes more fields than the userspace - version of the flow key, for example if the kernel decoded IPv6 - headers but userspace stopped at the Ethernet type (because it - does not understand IPv6), then again nothing special is - necessary. Userspace can still set up a flow in the usual way, - as long as it uses the kernel-provided flow key to do it. - - - If the userspace flow key includes more fields than the - kernel's, for example if userspace decoded an IPv6 header but - the kernel stopped at the Ethernet type, then userspace can - forward the packet manually, without setting up a flow in the - kernel. This case is bad for performance because every packet - that the kernel considers part of the flow must go to userspace, - but the forwarding behavior is correct. (If userspace can - determine that the values of the extra fields would not affect - forwarding behavior, then it could set up a flow anyway.) + - If userspace's notion of the flow key for the packet matches the + kernel's, then nothing special is necessary. + + - If the kernel's flow key includes more fields than the userspace + version of the flow key, for example if the kernel decoded IPv6 + headers but userspace stopped at the Ethernet type (because it + does not understand IPv6), then again nothing special is + necessary. Userspace can still set up a flow in the usual way, + as long as it uses the kernel-provided flow key to do it. + + - If the userspace flow key includes more fields than the + kernel's, for example if userspace decoded an IPv6 header but + the kernel stopped at the Ethernet type, then userspace can + forward the packet manually, without setting up a flow in the + kernel. This case is bad for performance because every packet + that the kernel considers part of the flow must go to userspace, + but the forwarding behavior is correct. (If userspace can + determine that the values of the extra fields would not affect + forwarding behavior, then it could set up a flow anyway.) How flow keys evolve over time is important to making this work, so the following sections go into detail. @@ -225,11 +225,11 @@ Other rules The other rules for flow keys are much less subtle: - - Duplicate attributes are not allowed at a given nesting level. + - Duplicate attributes are not allowed at a given nesting level. - - Ordering of attributes is not significant. + - Ordering of attributes is not significant. - - When the kernel sends a given flow key to userspace, it always - composes it the same way. This allows userspace to hash and - compare entire flow keys that it may not be able to fully - interpret. + - When the kernel sends a given flow key to userspace, it always + composes it the same way. This allows userspace to hash and + compare entire flow keys that it may not be able to fully + interpret. |