Skip to content

Commit

Permalink
Push docs to Relish.
Browse files Browse the repository at this point in the history
  • Loading branch information
yasuhito committed Apr 7, 2015
1 parent b02cb1a commit a7281c8
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 6 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ supports the following packet formats:
- Packet-Out
- Flow Mod
- Port Status
- OpenFlow 1.3
- [Hello](https://relishapp.com/trema/pio/docs/openflow-1-3-hello-message)
- (…currently there are just a few formats supported but I'm sure this list will grow)

## Features Overview
Expand Down Expand Up @@ -386,4 +388,5 @@ and install it by running Bundler:
## License

Pio is released under the GNU General Public License version 3.0:

- <http://www.gnu.org/licenses/gpl.html>
2 changes: 2 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ supports the following packet formats:
- Packet-Out
- Flow Mod
- Port Status
- OpenFlow 1.3
- [[https://relishapp.com/trema/pio/docs/openflow-1-3-hello-message][Hello]]
- (...currently there are just a few formats supported but I'm sure this list will grow)

** Features Overview
Expand Down
2 changes: 2 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
require 'bundler/gem_tasks'

RELISH_PROJECT = 'trema/pio'

# rubocop:disable HashSyntax

task :default => :travis
Expand Down
12 changes: 6 additions & 6 deletions features/hello13.feature
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Feature: OpenFlow 1.3 Hello message (Pio::Hello13 class)
Scenario: create an OpenFlow 1.3 Hello message
Feature: OpenFlow 1.3 Hello message
Scenario: create
When I create an OpenFlow message with "Pio::Hello13.new"
Then the message have the following field and value:
| field | value |
Expand All @@ -11,7 +11,7 @@ Feature: OpenFlow 1.3 Hello message (Pio::Hello13 class)
| xid | 0 |
| supported_versions | [:open_flow13] |

Scenario: create an OpenFlow 1.3 Hello message (transaction_id: 123)
Scenario: create (transaction_id: 123)
When I create an OpenFlow message with "Pio::Hello13.new(transaction_id: 123)"
Then the message have the following field and value:
| field | value |
Expand All @@ -23,7 +23,7 @@ Feature: OpenFlow 1.3 Hello message (Pio::Hello13 class)
| xid | 123 |
| supported_versions | [:open_flow13] |

Scenario: create an OpenFlow 1.3 Hello message (xid: 123)
Scenario: create (xid: 123)
When I create an OpenFlow message with "Pio::Hello13.new(xid: 123)"
Then the message have the following field and value:
| field | value |
Expand All @@ -35,7 +35,7 @@ Feature: OpenFlow 1.3 Hello message (Pio::Hello13 class)
| xid | 123 |
| supported_versions | [:open_flow13] |

Scenario: parse hello13_no_version_bitmap.raw
Scenario: parse (no version bitmap)
Given a packet data file "hello13_no_version_bitmap.raw"
When I try to parse the file with "Hello13" class
Then it should finish successfully
Expand All @@ -49,7 +49,7 @@ Feature: OpenFlow 1.3 Hello message (Pio::Hello13 class)
| xid | 0 |
| supported_versions | [] |

Scenario: parse hello13_version_bitmap.raw
Scenario: parse
Given a packet data file "hello13_version_bitmap.raw"
When I try to parse the file with "Hello13" class
Then it should finish successfully
Expand Down
1 change: 1 addition & 0 deletions pio.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Gem::Specification.new do |gem|

# Docs
gem.add_development_dependency 'inch', '~> 0.5.10'
gem.add_development_dependency 'relish', '~> 0.7.1'
gem.add_development_dependency 'yard', '~> 0.8.7.6'

# Test
Expand Down
8 changes: 8 additions & 0 deletions tasks/coveralls.rake
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
begin
require 'coveralls/rake/task'
Coveralls::RakeTask.new
rescue LoadError
task 'coveralls:push' do
$stderr.puts 'Coveralls is disabled'
end
end

0 comments on commit a7281c8

Please sign in to comment.