Permalink
Browse files

Switch to Markdown formatted files, and reset the Rakefile.

  • Loading branch information...
postmodern committed May 11, 2010
1 parent fb4ea90 commit 0331b5437213267cb22aea966fcd86b5b67bb345
Showing with 39 additions and 68 deletions.
  1. +1 −0 .specopts
  2. +1 −0 .yardopts
  3. +10 −5 ChangeLog.rdoc → ChangeLog.md
  4. +7 −8 README.rdoc → README.md
  5. +20 −2 Rakefile
  6. +0 −6 tasks/rcov.rb
  7. +0 −17 tasks/rdoc.rb
  8. +0 −9 tasks/spec.rb
  9. +0 −21 tasks/yard.rb
View
@@ -0,0 +1 @@
+--colour --format specdoc
View
@@ -0,0 +1 @@
+--markup markdown --title 'FFI PCap Documentation' --protected --files ChangeLog.md,LICENSE.txt
@@ -1,14 +1,18 @@
-=== 0.2.0 / 2010-04-22
+### 0.2.0 / 2010-04-22
+
* emonti fork merged back into sophsec/ffi-pcap
* ... ignore that whole "caper" thing. It will return as another lib entirely.
-=== 0.1.4 / 2010-04-20 (emonti/ffi-pcap)
+### 0.1.4 / 2010-04-20 (emonti/ffi-pcap)
+
* Fixes and example for pcap dumper
-=== 0.1.3 / 2010-03-05 (emonti/ffi-pcap)
+### 0.1.3 / 2010-03-05 (emonti/ffi-pcap)
+
* Minor fixes for ruby 1.9 compatability
-=== 0.1.2 / 2010-01-03 (emonti/ffi-pcap)
+### 0.1.2 / 2010-01-03 (emonti/ffi-pcap)
+
* Branched from sophsec/ffi-pcap by emonti
* Using ffi_dry for common struct interface
* Redesigned the pcap-specific pcap_pkthdr struct.
@@ -23,5 +27,6 @@
* Lots of other stuff I'm probably forgetting.
* specs all pass on OS X, Linux, and Win32(except 1 which is a known issue)
-=== 0.1.0 / 2009-04-29 (sophsec/ffi-pcap)
+### 0.1.0 / 2009-04-29 (sophsec/ffi-pcap)
+
* Initial release.
View
@@ -1,30 +1,29 @@
-= ffi-pcap
+# ffi-pcap
* [github.com/sophsec/ffi-pcap](http://github.com/sophsec/ffi-pcap/)
* [github.com/sophsec/ffi-pcap/issues](http://github.com/sophsec/ffi-pcap/issues)
* Postmodern (postmodern.mod3 at gmail.com)
* Eric Monti (esmonti at gmail.com)
-== Description
+## Description
Ruby FFI bindings for libpcap.
-== Features
+## Features
-== Examples
+## Examples
-== Requirements
+## Requirements
* [libpcap](http://www.tcpdump.org/) or [winpcap](http://winpcap.org/)
* [ffi](http://github.com/ffi/ffi) >= 0.5.0
* [ffi_dry](http://github.com/emonti/ffi_dry) >= 0.1.9
-== Install
+## Install
$ sudo gem install ffi-pcap
-== License
+## License
See {file:LICENSE.txt} for license information.
-
View
@@ -1,7 +1,5 @@
require 'rubygems'
-Dir["tasks/*.rb"].each {|rt| require rt }
require 'rake/clean'
-require './lib/ffi/pcap/version.rb'
# Generate a gem using jeweler
begin
@@ -22,3 +20,23 @@ begin
rescue LoadError
puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
end
+
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+ t.libs += ['lib', 'spec']
+ t.spec_opts = ['--colour', '--format', 'specdoc']
+end
+task :default => :spec
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+ spec.libs << 'lib' << 'spec'
+ spec.pattern = 'spec/**/*_spec.rb'
+ spec.rcov = true
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :docs => :yard
View
@@ -1,6 +0,0 @@
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:rcov) do |spec|
- spec.libs << 'lib' << 'spec'
- spec.pattern = 'spec/**/*_spec.rb'
- spec.rcov = true
-end
View
@@ -1,17 +0,0 @@
-
-require 'rake/rdoctask'
-
-Rake::RDocTask.new do |rdoc|
- if File.exist?('VERSION')
- version = "- #{File.read('VERSION')}"
- else
- version = ""
- end
-
- rdoc.rdoc_dir = 'rdoc'
- rdoc.title = "FFI PCap Documentation #{version}"
- rdoc.rdoc_files.include('README*')
- rdoc.rdoc_files.include('ChangeLog*')
- rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
View
@@ -1,9 +0,0 @@
-require 'spec/rake/spectask'
-
-desc "Run all specifications"
-Spec::Rake::SpecTask.new(:spec) do |t|
- t.libs += ['lib', 'spec']
- t.spec_opts = ['--colour', '--format', 'specdoc']
-end
-
-task :default => :spec
View
@@ -1,21 +0,0 @@
-begin
- require 'yard'
-
- YARD::Rake::YardocTask.new do |t|
- if File.exist?('VERSION')
- version = "- #{File.read('VERSION')}"
- else
- version = ""
- end
-
- t.files = ['ChangeLog*','LICENSE*','lib/**/*.rb']
- t.options = [
- '--title',"FFI PCap Documentation #{version}",
- '--protected',
- ]
- end
-
- task :docs => :yard
-rescue LoadError
-end
-

0 comments on commit 0331b54

Please sign in to comment.