malloc 1.3.5 → 1.3.6

data/README.md

@@ -1,4 +1,39 @@
 malloc
 ======
+
+**Author**:       Jan Wedekind
+**Copyright**:    2010
+**License**:      GPL
+
+Synopsis
+--------
+
 This Ruby extension defines the class {Hornetseye::Malloc}. {Hornetseye::Malloc.new} allows you to allocate memory, using {Hornetseye::Malloc#+} one can do pointer manipulation, and {Hornetseye::Malloc#read} and {Hornetseye::Malloc#write} provide reading Ruby strings from memory and writing Ruby strings to memory.
 
+Installation
+------------
+
+To install this Ruby extension, use the following command:
+
+    $ sudo gem install hornetseye-alsa
+
+Alternatively you can build and install the Ruby extension from source as follows:
+
+    $ rake
+    $ sudo rake install
+
+Usage
+-----
+
+Simply run Interactive Ruby:
+
+    $ irb
+
+You can load the Ruby extension like this:
+
+    require 'rubygems'
+    require 'malloc'
+    include Hornetseye
+
+See documentation of {Hornetseye::Malloc} on how to use this Ruby extension.
+

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/loaders/makefile'
 require 'rbconfig'
 
 PKG_NAME = 'malloc'
-PKG_VERSION = '1.3.5'
+PKG_VERSION = '1.3.6'
 CFG = RbConfig::CONFIG
 CXX = ENV[ 'CXX' ] || 'g++'
 RB_FILES = FileList[ 'lib/**/*.rb' ]

data/lib/malloc_ext.rb

@@ -45,8 +45,6 @@ module Hornetseye
       # Allocate the specified number of bytes of raw memory.
       #
       # @example Allocate raw memory
-      #   require 'malloc'
-      #   include Hornetseye
       #   m = Malloc.new 32
       #   # Malloc(32)
       #
@@ -67,8 +65,6 @@ module Hornetseye
     # Number of bytes allocated
     #
     # @example Querying size of allocated memory
-    #   require 'malloc'
-    #   include Hornetseye
     #   m = Malloc.new 32
     #   m.size
     #   # 32
@@ -81,8 +77,7 @@ module Hornetseye
     # Display information about this object
     #
     # @example Displaying information about a Malloc object
-    #   require 'malloc'
-    #   Hornetseye::Malloc.new( 8 ).inspect
+    #   Malloc.new( 8 ).inspect
     #   "Malloc(8)"
     #
     # @return [String] A string with information about this object.
@@ -110,8 +105,7 @@ module Hornetseye
     # Display information about this object
     #
     # @example Displaying information about a Malloc object
-    #   require 'malloc'
-    #   Hornetseye::Malloc.new( 8 ).to_s
+    #   Malloc.new( 8 ).to_s
     #   "Malloc(8)"
     #
     # @return [String] A string with information about this object.
@@ -122,8 +116,6 @@ module Hornetseye
     # Operator for doing pointer arithmetic
     #
     # @example Pointer arithmetic
-    #   require 'malloc'
-    #   include Hornetseye
     #   m = Malloc.new 4
     #   # Malloc(4)
     #   m.write 'abcd'
@@ -149,8 +141,6 @@ module Hornetseye
     # Read data from memory
     #
     # @example Reading and writing data
-    #   require 'malloc'
-    #   include Hornetseye
     #   m = Malloc.new 4
     #   # Malloc(4)
     #   m.write 'abcd'
@@ -173,8 +163,6 @@ module Hornetseye
     # Write data to memory
     #
     # @example Reading and writing data
-    #   require 'malloc'
-    #   include Hornetseye
     #   m = Malloc.new 4
     #   # Malloc(4)
     #   m.write 'abcd'
@@ -208,8 +196,6 @@ module Hornetseye
   # Shortcut for instantiating Malloc object
   #
   # @example Create malloc object
-  #   require 'malloc'
-  #   include Hornetseye
   #   m = Malloc 4
   #   # Malloc(4)
   #

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 5
-  version: 1.3.5
+  - 6
+  version: 1.3.6
 platform: ruby
 authors: 
 - Jan Wedekind
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 +00:00
+date: 2010-11-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency