ruby_abc 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fd5883ec3a3da72ba747cc3de5d52f7dc467b66
-  data.tar.gz: e6d50ed52c1ac424870f97e40314eb466c989d26
+SHA256:
+  metadata.gz: bbfda9e554b3b4fae865a44d0709722d5496f1e1d7b94813f1dd9ea0969397ad
+  data.tar.gz: 52b2059d866ebc0f47185371321efa28567ce683e1ef3b5ad71942dd63a70704
 SHA512:
-  metadata.gz: adaebecb0852ab57632b491da54a02fca3e2eb89ff3cae799847a69df248e5214a27c8447b62d7c277de478c146fb7aeca4830ea4611936067061bfcacae55d4
-  data.tar.gz: 86df84083bec60c1f1e74998dd20dd387d02956c2546a5c3ec049febf56363e9f5180654ea59749166f6cedced47c2065c5f057a3ade3085f2279646473bc201
+  metadata.gz: 6fc4334bf986fa58c55647f07033b9788fcbcedb8375ec57b89368fc81dc7af07f9b1bd361147a7ac8a61b38d39241c601ff86660533a9037f4e15daefb1a91e
+  data.tar.gz: 45f2d5e039c288655b354daf79a06ef5cee657e19f39e909ebe42674c61c5b18ae90c0f8c76e27938bf6d956a73c7e32d02f140ab96682c938ad0d8a3365778c

data/.yardopts

@@ -0,0 +1,7 @@
+--readme README.md
+--title 'Ruby ABC'
+--verbose
+--charset utf-8
+--markup markdown
+'lib/**/*.rb'
+'ext/ruby_abc/ruby_abc.c'

data/LICENSE

@@ -1,52 +1,51 @@
-Directory ext/abc is cloned from https://bitbucket.org/alanmi/abc on 2017-11-22 (hg clone https://bitbucket.org/alanmi/abc)
-
-ABC: System for Sequential Synthesis and Verification
-
-http://www.eecs.berkeley.edu/~alanmi/abc/
-
-
-Copyright (c) The Regents of the University of California. All rights reserved.
-
-Permission is hereby granted, without written agreement and without license or
-royalty fees, to use, copy, modify, and distribute this software and its
-documentation for any purpose, provided that the above copyright notice and
-the following two paragraphs appear in all copies of this software.
-
-IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
-DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
-THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
-CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
-BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
-AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
-SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-
-
---------------------------------------------------------------------------------
-
-
-ruby_abc: A ruby C extension to use ABC from ruby
-
-http://rubygems.org/gems/ruby_abc
-
-
-Copyright (c) 2017 Théotime Bollengier. All rights reserved.
-
-Permission is hereby granted, without written agreement and without license or
-royalty fees, to use, copy, modify, and distribute this software and its
-documentation for any purpose, provided that the above copyright notice and
-the following two paragraphs appear in all copies of this software.
-
-IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR
-DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
-THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHOR
-HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
-BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
-AND THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
-SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-
+Directory ext/abc is cloned from https://bitbucket.org/alanmi/abc on 2017-11-22 (hg clone https://bitbucket.org/alanmi/abc)
+
+ABC: System for Sequential Synthesis and Verification
+
+http://www.eecs.berkeley.edu/~alanmi/abc/
+
+
+Copyright (c) The Regents of the University of California. All rights reserved.
+
+Permission is hereby granted, without written agreement and without license or
+royalty fees, to use, copy, modify, and distribute this software and its
+documentation for any purpose, provided that the above copyright notice and
+the following two paragraphs appear in all copies of this software.
+
+IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
+DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
+THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
+CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
+AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
+SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+
+
+--------------------------------------------------------------------------------
+
+
+ruby_abc: A ruby C extension to use ABC from ruby
+
+https://gitlab.ensta-bretagne.fr/argen/ruby_abc
+
+
+Copyright (c) 2017,2022 Théotime Bollengier. All rights reserved.
+
+Permission is hereby granted, without written agreement and without license or
+royalty fees, to use, copy, modify, and distribute this software and its
+documentation for any purpose, provided that the above copyright notice and
+the following two paragraphs appear in all copies of this software.
+
+IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR
+DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
+THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHOR
+HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
+AND THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
+SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

data/README.md

@@ -68,28 +68,29 @@ Installation
 
 To install *ruby_abc* from the git repository:
 
-```lang-none
-$ git clone https://github.com/TheotimeBollengier/ruby_abc
-$ cd ruby_abc
-$ gem build ruby_abc.gemspec
-$ gem install ruby_abc.<version>.gem
+```bash
+git clone https://gitlab.ensta-bretagne.fr/argen/ruby_abc.git
+cd ruby_abc
+gem build ruby_abc.gemspec
+gem install ruby_abc.<version>.gem
 ```
 
 Alternatively, *ruby_abc* gem is also hosted on RubyGems ([https://rubygems.org/gems/ruby_abc](https://rubygems.org/gems/ruby_abc)).
 So you can simply type:
 
-```lang-none
-$ gem install ruby_abc
+```bash
+gem install ruby_abc
 ```
 
 This will build *abc* and the *ruby_abc* extension, and install it.
 Building *abc* may take quite some time.
+To speed up the build, you may `export MAKEFLAGS=' -j8 '` before installing the gem.
 
 As this gem includes a C extension, building it requires the ruby developpement headers.
 On Debian, you can get them with:
 
-```lang-none
-$ sudo apt-get install ruby-dev 
+```bash
+sudo apt-get install ruby-dev 
 ```
 
 
@@ -101,34 +102,53 @@ this gem also include the `ruby_abc` executable script, which uses command line
 
 ```lang-none
 $ ruby_abc --help
-Usage: rubyabc_synthesis [options] -i <input_file> -o <output_file>
- -i, --input FILE                 Input BLIF file
- -o, --output FILE                Output netlist to FILE
- -r, --retime                     Retime netlist
- -z, --zero                       Set latches initial value to zero
- -l, --lcorr                      Computes latch correspondence using 1-step induction
- -a, --area                       Optimize for area instead of performance (minimize the number of nodes instead of the logic level)
- -w, --sweep                      Sweep logic network to remove dangling nodes
- -k, --lut_inputs K               Map to K-input LUTs.
- -h, --help                       Display this help
+Usage: ruby_abc [options] -i <input_file> -o <output_file>
+    -i, --input FILE       Input file
+    -o, --output FILE      Write processed netlist to FILE
+    -s, --sweep            Sweep logic network to remove dangling nodes
+    -k, --lut-inputs K     Map to K-input LUTs.
+    -a, --area             Optimize in area
+    -r, --retime           Retime netlist
+    -l, --lcorr            Computes latch correspondence using 1-step induction
+    -z, --zero             Set latches initial value to zero
+    -e, --echo             Echo commands sent to ABC
+    -q, --quiet            Do not print netlist statistics during synthesis
+    -m, --map [GATE_LIB]   Map the netlist to the logic gate library defined in GATE_LIB.
+                             osu:       pseudo standard cell library inspired from OSU018,
+                             simple:    simple library with only BUF, INV, AND, OR, XOR, NAND, NOR and XNOR,
+                             file name: path of a library file in the GNELIB format.
+                             Defaults to 'osu'.
+    -h, --help             Display this help
 ```
 
-The *abc* executable is also included so that it can be used natively without ruby.
+
+Bash completion
+---------------
+
+If you want to have bash completion in your terminal for the _ruby\_abc_ command, 
+copy the file [`share/bash_completion/ruby_abc.bash-completion.sh`](share/bash_completion/ruby_abc.bash-completion.sh)
+to your `/etc/bash_completion.d/` directory.
 
 
 Documentation
 -------------
 
-Html documentation for *ruby_abc* can be generated with `rake doc`.
+Documentation of *ruby_abc* is available at [rubydoc.info](https://www.rubydoc.info/gems/ruby_abc).
+
+You can also build the documentation yourself using YARD:
+
+```bash
+# Install Yard if you do not have it yet
+gem install yard
+# Call yard in the ruby_abc directory
+yard
+# View the generated documentation
+firefox doc/index.html
+```
+
 This documentation covers only the API of *ruby_abc*, not *abc* itself.
 *abc* documentation can be found on [http://people.eecs.berkeley.edu/~alanmi/abc/](https://people.eecs.berkeley.edu/~alanmi/abc/).
-Also, available *abc* commands can be retreived with `ABC.help` (in ruby), 
+Also, available *abc* commands can be retreived ith `ABC.help` (in ruby),
 and specific command documentation can be seen with `ABC.run_command('<command_name> -h')` (in ruby).
 
 
-Test
-----
-
-`$ rake test` will execute `test/test_ruby_abc.rb`.
-This will read a BLIF netlist, optimize it and check the result against a golden model.
-

data/bin/ruby_abc

@@ -1,86 +1,103 @@
 #! /usr/bin/env ruby
 
-require 'ruby_abc'
 require 'optparse'
+require_relative '../lib/ruby_abc.rb'
 
 STDOUT.sync = true
 
 options = {}
 
 optparse = OptionParser.new do |opts|
-	opts.banner = "Usage: #{File.basename(__FILE__)} [options] -i <input_file> -o <output_file>"
-
-	options[:inputFileName] = nil
-	opts.on('-i', '--input FILE', 'Input file') do |file|
-		options[:inputFileName] = file
-	end
-
-	options[:outputFileName] = nil
-	opts.on('-o', '--output FILE', 'Write processed netlist to FILE') do |file|
-		options[:outputFileName] = file
-	end
-
-	options[:sweep] = false
-	opts.on('-s', '--sweep', 'Sweep logic network to remove dangling nodes') do
-		options[:sweep] = true
-	end
-
-	options[:k] = nil
-	opts.on('-k', '--lut_inputs K', "Map to K-input LUTs.") do |k|
-		options[:k] = k.to_i
-	end
-
-	options[:area] = false
-	opts.on('-a', '--area', 'Optimize in area') do
-		options[:area] = true
-	end
-
-	options[:retime] = false
-	opts.on('-r', '--retime', 'Retime netlist') do
-		options[:retime] = true
-	end
-
-	options[:lcorr] = false
-	opts.on('-l', '--lcorr', 'Computes latch correspondence using 1-step induction') do
-		options[:lcorr] = true
-	end
-
-	options[:zero] = false
-	opts.on('-z', '--zero', 'Set latches initial value to zero') do
-		options[:zero] = true
-	end
-
-	options[:echo] = false
-	opts.on('-e', '--echo', 'Echo commands sent to ABC') do
-		options[:echo] = true
-	end
-
-	options[:quiet] = false
-	opts.on('-q', '--quiet', 'Do not print netlist statistics during synthesis') do
-		options[:quiet] = true
-	end
-
-	opts.on( '-h', '--help', 'Display this help' ) do
-		puts opts
-		exit
-	end
+  opts.banner = "Usage: #{File.basename($0)} [options] -i <input_file> -o <output_file>"
+
+  options[:inputFileName] = nil
+  opts.on('-i', '--input FILE', 'Input file') do |file|
+    options[:inputFileName] = file
+  end
+
+  options[:outputFileName] = nil
+  opts.on('-o', '--output FILE', 'Write processed netlist to FILE') do |file|
+    options[:outputFileName] = file
+  end
+
+  options[:sweep] = false
+  opts.on('-s', '--sweep', 'Sweep logic network to remove dangling nodes') do
+    options[:sweep] = true
+  end
+
+  options[:k] = nil
+  opts.on('-k', '--lut-inputs K', "Map to K-input LUTs.") do |k|
+    options[:k] = k.to_i
+  end
+
+  options[:area] = false
+  opts.on('-a', '--area', 'Optimize in area') do
+    options[:area] = true
+  end
+
+  options[:retime] = false
+  opts.on('-r', '--retime', 'Retime netlist') do
+    options[:retime] = true
+  end
+
+  options[:lcorr] = false
+  opts.on('-l', '--lcorr', 'Computes latch correspondence using 1-step induction') do
+    options[:lcorr] = true
+  end
+
+  options[:zero] = false
+  opts.on('-z', '--zero', 'Set latches initial value to zero') do
+    options[:zero] = true
+  end
+
+  options[:echo] = false
+  opts.on('-e', '--echo', 'Echo commands sent to ABC') do
+    options[:echo] = true
+  end
+
+  options[:quiet] = false
+  opts.on('-q', '--quiet', 'Do not print netlist statistics during synthesis') do
+    options[:quiet] = true
+  end
+
+  options[:map] = false
+  options[:map_lib] = nil
+  opts.on('-m', '--map [GATE_LIB]', "Map the netlist to the logic gate library defined in GATE_LIB.\n" +
+          "                                       osu:       pseudo standard cell library inspired from OSU018,\n" + 
+          "                                       simple:    simple library with only BUF, INV, AND, OR, XOR, NAND, NOR and XNOR,\n" + 
+          "                                       file name: path of a library file in the GNELIB format.\n" + 
+          "                                       Defaults to 'osu'."
+         ) do |gatelib|
+    options[:map] = true
+    options[:map_lib] = gatelib
+  end
+
+  opts.on( '-h', '--help', 'Display this help' ) do
+    puts opts
+    exit
+  end
 end
 
 optparse.parse!
 
 abort "Missing input file name.\n#{optparse}" if options[:inputFileName].nil?
 
+if options[:k] and options[:map] then
+  abort "ERROR: Options -k and -m are exclusive.\n       Either map the netlist to LUTs or to a logic gate library"
+end
+
 ABC::echo_commands = not(not(options[:echo]))
 
 ABC::synthesis(
-	input:   options[:inputFileName], 
-	output:  options[:outputFileName], 
-	zero:    options[:zero], 
-	sweep:   options[:sweep],
-	retime:  options[:retime], 
-	lcorr:   options[:lcorr], 
-	area:    options[:area], 
-	lut_map: options[:k],
-	verbose: not(options[:quiet])
+  input:   options[:inputFileName], 
+  output:  options[:outputFileName], 
+  zero:    options[:zero], 
+  sweep:   options[:sweep],
+  retime:  options[:retime], 
+  lcorr:   options[:lcorr], 
+  area:    options[:area], 
+  lut_map: options[:k],
+  gatelib: options[:map] ? (options[:map_lib].is_a?(String) ? options[:map_lib] : true) : false,
+  verbose: not(options[:quiet])
 )
 

data/ext/ruby_abc/extconf.rb

@@ -0,0 +1,58 @@
+require 'mkmf'
+
+dev = false
+force_llvm = false
+llvm = ((MakeMakefile::CONFIG['CC'] == 'clang') or force_llvm)
+
+
+ext_dir = File.dirname(File.expand_path(__FILE__))
+abc_dir = File.expand_path('../berkeley-abc', ext_dir)
+abc_url = 'https://github.com/berkeley-abc/abc.git'
+lib_abc = File.join(abc_dir, 'libabc.a')
+
+unless File.directory?(abc_dir) then
+  abort "--- ERROR ---\nCannot find git executable needed to clone #{abc_url}\n-------------" unless find_executable('git')
+  abort "--- ERROR ---\nCannot clone #{abc_url}\n-------------" unless system("git clone --depth=1 '#{abc_url}' '#{abc_dir}'")
+end
+
+unless File.file?(lib_abc) then
+  unless system("make -C '#{abc_dir}' ABC_USE_PIC=1 OPTLAGS='-O2' ABC_USE_NO_READLINE=1 ABC_USE_STDINT_H=1 libabc.a") then
+    abort "--- ERROR ---\nCannot make libabc.a\n-------------"
+  end
+end
+
+if force_llvm then
+  MakeMakefile::CONFIG['CC'] =  'clang'
+  MakeMakefile::CONFIG['CXX'] = 'clang++'
+  RbConfig::CONFIG['CC'] =      'clang'
+  RbConfig::CONFIG['CPP'] =     'clang -E'
+  $CFLAGS << ' -fdeclspec -Wno-unknown-warning-option'
+end
+
+unless have_library('stdc++') then
+    abort "--- ERROR ---\nCannot find libstdc++\n-------------"
+end
+
+dir_config('abc', File.join(abc_dir, 'src'), abc_dir)
+unless have_library('abc') then
+    abort "--- ERROR ---\nCannot find libabc\n-------------"
+end
+
+append_cflags  '-fvisibility=hidden'
+append_cflags  '-DABC_USE_STDINT_H=1'
+append_ldflags '-Wl,--version-script=ruby_abc.map'
+
+if dev then
+  append_cflags '-Wall'
+  append_cflags '-Wextra'
+  append_cflags '-Wno-unused-parameter'
+end
+append_cflags '-Wno-suggest-attribute=format'
+append_cflags '-Wno-shift-negative-value'
+append_cflags '-Wno-sign-compare'
+append_cflags '-Wno-unused-function'
+
+create_makefile 'ruby_abc/ruby_abc'
+
+File.write('Makefile', File.read('Makefile').sub(/^V = 0$/, 'V = 1')) if dev
+

data/ext/{ruby_abc.c → ruby_abc/ruby_abc.c}

@@ -5,13 +5,9 @@
 static int rubyabc_echo_commands = 1;
 
 
-/* call-seq:
- * nb_ands -> integer or nil
- *
- * Return the number of AND gate in the network.  
- * If no network have been loaded or the then network is not in AIG form, return +nil+.
- *
- *  ABC.nb_ands #=> 264
+/* Returns the number of AND-inverter gates in the network.  
+ * If no network have been loaded or the then network is not in AIG form, returns _nil_.
+ * @return [Integer, nil]
  */
 static VALUE rubyabc_n_ands(VALUE self)
 {
@@ -24,13 +20,9 @@ static VALUE rubyabc_n_ands(VALUE self)
 }
 
 
-/* call-seq:
- * nb_nodes -> integer or nil
- *
- * Return the number combinatorial logic nodes in the network.  
- * If no network have been loaded or the then network is in AIG form, return +nil+.
- *
- *  ABC.nb_nodes #=> 114
+/* Returns the number combinatorial logic nodes in the network.
+ * If no network have been loaded or the then network is in AIG form, returns _nil_.
+ * @return [Integer, nil]
  */
 static VALUE rubyabc_n_nodes(VALUE self)
 {
@@ -43,13 +35,9 @@ static VALUE rubyabc_n_nodes(VALUE self)
 }
 
 
-/* call-seq:
- * nb_primary_inputs -> integer or nil
- *
- * Return the number of primary inputs of the network.  
- * If no network have been loaded, return +nil+.
- *
- *  ABC.nb_primary_inputs #=> 7
+/* Returns the number of primary inputs of the network.
+ * If no network have been loaded, return _nil_.
+ * @return [Integer, nil]
  */
 static VALUE rubyabc_n_pis(VALUE self)
 {
@@ -62,13 +50,9 @@ static VALUE rubyabc_n_pis(VALUE self)
 }
 
 
-/* call-seq:
- * nb_primary_outputs -> integer or nil
- *
- * Return the number of primary outputs of the network.  
- * If no network have been loaded, return +nil+.
- *
- *  ABC.nb_primary_outputs #=> 6
+/* Returns the number of primary outputs of the network.  
+ * If no network have been loaded, return _nil_.
+ * @return [Integer, nil]
  */
 static VALUE rubyabc_n_pos(VALUE self)
 {
@@ -81,13 +65,9 @@ static VALUE rubyabc_n_pos(VALUE self)
 }
 
 
-/* call-seq:
- * nb_latches -> integer or nil
- *
- * Return the number of latches in the network.  
- * If no network have been loaded, return +nil+.
- *
- *  ABC.nb_latches #=> 17
+/* Returns the number of latches in the network.  
+ * If no network have been loaded, return _nil_.
+ * @return [Integer, nil]
  */
 static VALUE rubyabc_n_latches(VALUE self)
 {
@@ -100,15 +80,11 @@ static VALUE rubyabc_n_latches(VALUE self)
 }
 
 
-/* call-seq:
- * nb_levels -> integer or nil
- *
- * Return the number of logic levels.  
+/* Returns the number of logic levels.  
  * This is the number of combinatorial logic between two latches
  * or primary input/output.
- * If no network have been loaded, return +nil+.
- *
- *  ABC.nb_latches #=> 8
+ * If no network have been loaded, return _nil_.
+ * @return [Integer, nil]
  */
 static VALUE rubyabc_n_levels(VALUE self)
 {
@@ -121,13 +97,13 @@ static VALUE rubyabc_n_levels(VALUE self)
 }
 
 
-/* call-seq:
- * run_command (string)
- *
- * Run the command +string+ in ABC.
+/* Run the command _string_ in ABC.
  *
- * If ABC::echo_commands has been set to true, +string+ will be echoed on STDOUT before it is given to +abc+.
+ * If ABC::echo_commands has been set to _true_, _string_ will be echoed on STDOUT before it is given to ABC.
  *
+ * @param cmd [String]
+ * @return [Boolean] _true_ if the command succeeded, _false_ otherwise.
+ * @example
  *  ABC.run_command 'read netlist.blif; strash; resyn; if -K 4; write out.blif'
  *  # To see available ABC commands:
  *  ABC.run_command 'help'
@@ -154,12 +130,8 @@ static VALUE rubyabc_run_command(VALUE self, VALUE cmd)
 }
 
 
-/* call-seq:
- * echo_commands -> true or false
- *
- * Return if each command received is echoed back.
- *
- *  ABC.echo_commands #=> true
+/* Return if each command sent to ABC is to be echoed back.
+ * @return [Boolean]
  */
 static VALUE rubyabc_get_echo_commands(VALUE self)
 {
@@ -169,21 +141,16 @@ static VALUE rubyabc_get_echo_commands(VALUE self)
 }
 
 
-/* call-seq:
- * echo_commands= (boolean)
- *
- * Set whether each command is echoed or not.
- *
- *  ABC.echo_commands = false
+/* Set whether each command sent to ABC is to be echoed back or not.
+ * @param b [Boolean]
+ * @return b
  */
 static VALUE rubyabc_set_echo_commands(VALUE self, VALUE b)
 {
-	if (b == Qtrue)
-		rubyabc_echo_commands = 1;
-	else if (b == Qfalse || b == Qnil)
+	if (b == Qfalse || b == Qnil)
 		rubyabc_echo_commands = 0;
 	else
-		rb_raise(rb_eTypeError, "expecting true or false");
+		rubyabc_echo_commands = 1;
 
 	return Qnil;
 }
@@ -191,19 +158,19 @@ static VALUE rubyabc_set_echo_commands(VALUE self, VALUE b)
 
 /* Document-module: ABC
  *
- * ABC module wrapps the command line interface of the Berkeley +abc+ program.
- * +abc+ is a system for sequential synthesis and verification, developped at the University of California, Berkeley.
+ * This module wrapps the command line interface of the Berkeley ABC program.
+ * ABC is a system for sequential synthesis and verification, developped at the University of California, Berkeley.
  * Documentation on ABC can be found at [http://people.eecs.berkeley.edu/~alanmi/abc/](https://people.eecs.berkeley.edu/~alanmi/abc/)
  *
- * The +abc+ program is a command line interface: the user issue commands and adjust them according to the results he gets back.
+ * The ABC program is a command line interface: the user issues commands and adjust them according to the results he gets back.
  * In order to automate this process, the ABC module allows to retreive some information on the logic network in ruby, 
  * such as the number of nodes or its logic level. The command adjustment can then be done in ruby instead of manually.
  *
- * +abc+ commands are issued with the ABC::run_command module method, thus the +abc+ documentation is not covered in this API documentation.
- * However, available commands can be retreived with ABC::run_command('help'), 
- * and the documentation of a given command can be retreived with ABC::run_command('command_name -h').
+ * ABC commands are issued with the {ABC::run_command} module function, thus the ABC documentation is not covered in this API documentation.
+ * However, available commands can be retreived with `ABC.run_command('help')', 
+ * and the documentation of a given command can be retreived with `ABC.run_command('command_name -h')`.
  */
-void Init_ruby_abc() 
+RUBY_ABC_PUBLIC void Init_ruby_abc() 
 {
 	VALUE rubyabc_mABC;
 
@@ -219,6 +186,7 @@ void Init_ruby_abc()
 	rb_define_module_function(rubyabc_mABC, "echo_commands=",     rubyabc_set_echo_commands, 1);
 
 	rubyabc_c_start();
+
 	rubyabc_c_run_command("set check");
 	rubyabc_c_run_command("alias ps      print_stats");
 	rubyabc_c_run_command("alias st      strash");