man/man1/inochi.1 in inochi-6.0.2 vs man/man1/inochi.1 in inochi-6.1.0
- old
+ new
@@ -1,15 +1,15 @@
'\" t
.\" Title: inochi
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 2011-04-21
+.\" Date: 2011-06-29
.\" Manual: \ \&
-.\" Source: \ \& 6.0.2
+.\" Source: \ \& 6.1.0
.\" Language: English
.\"
-.TH "INOCHI" "1" "2011\-04\-21" "\ \& 6\&.0\&.2" "\ \&"
+.TH "INOCHI" "1" "2011\-06\-29" "\ \& 6\&.1\&.0" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
@@ -178,11 +178,11 @@
.sp -1
.IP \(bu 2.3
.\}
[AsciiDoc]
-8\&.5\&.3 or newer\&.
+8\&.6\&.5 or newer\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -908,13 +908,16 @@
.PP
test/runner
.RS 4
Executable Ruby script that hides the details of running the test suite\&.
.RE
-.sp
-test/test_helper\&.rb: Ruby source file that prepares the testing environment by loading a testing library and defining common knowledge and utility logic shared by the actual tests\&.
.PP
+test/test_helper\&.rb
+.RS 4
+Ruby source file that prepares the testing environment by loading a testing library and defining common knowledge and utility logic shared by the actual tests\&.
+.RE
+.PP
test/**/*_test\&.rb
.RS 4
Ruby source files that perform the actual testing\&.
.RE
.SS "Shell command"
@@ -1008,12 +1011,12 @@
.sp
.if n \{\
.RS 4
.\}
.nf
-inochi \-\-help # display help manual
-inochi \-\-tasks # list available tasks
+bundle exec inochi \-\-help # display help manual
+bundle exec inochi \-\-tasks # list available tasks
.fi
.if n \{\
.RE
.\}
.SS "$LOAD_PATH setup"
@@ -1024,12 +1027,12 @@
.sp
.if n \{\
.RS 4
.\}
.nf
-ruby \-Ilib bin/inochi
-irb \-Ilib \-r inochi
+bundle exec ruby \-Ilib bin/inochi
+bundle exec irb \-Ilib \-r inochi
.fi
.if n \{\
.RE
.\}
.sp
@@ -1037,71 +1040,168 @@
.sp
.if n \{\
.RS 4
.\}
.nf
-export RUBYLIB=lib # bash, ksh, zsh
-setenv RUBYLIB lib # csh
-set \-x RUBYLIB lib # fish
-
-ruby bin/inochi
-irb \-r inochi
+env RUBYLIB=lib bundle exec ruby bin/inochi
+env RUBYLIB=lib bundle exec irb \-r inochi
.fi
.if n \{\
.RE
.\}
+.SS "Running tests"
.sp
-Or by running Ruby through the \m[blue]\fBruby\-wrapper\fR\m[]\&\s-2\u[2]\d\s+2 tool\&.
-.SS "RubyGems setup"
+Simply execute the included test runner, which sets up Ruby\(cqs $LOAD_PATH for testing, loads the included test/test_helper\&.rb file, and then evaluates all test/**/*_test\&.rb files:
.sp
-If you use Ruby 1\&.8 or older, then ensure that RubyGems is activated before you use any libraries in the lib/ directory or run any executables in the bin/ directory\&.
-.sp
-This can be achieved by passing an option to Ruby:
-.sp
.if n \{\
.RS 4
.\}
.nf
-ruby \-rubygems bin/inochi
-irb \-rubygems \-r inochi
+ruby test/runner
.fi
.if n \{\
.RE
.\}
.sp
-Or by setting the $RUBYOPT environment variable:
+Its exit status will indicate whether all tests have passed\&. It may also print additional pass/fail information depending on the testing library used in the test/test_helper\&.rb file\&.
+.SS "Contributing"
.sp
-.if n \{\
+\m[blue]\fBFork this project on GitHub\fR\m[] and send a pull request\&.
+.SH "HISTORY"
+.SS "Version 6\&.1\&.0 (2011\-06\-29)"
+.PP
+\fBPrerequisite changes\fR
+.sp
.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
.\}
-.nf
-export RUBYOPT=\-rubygems # bash, ksh, zsh
-setenv RUBYOPT \-rubygems # csh
-set \-x RUBYOPT \-rubygems # fish
-.fi
-.if n \{\
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+AsciiDoc 8\&.6\&.5 is now required\&.
.RE
+.PP
+\fBNew features\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
.\}
-.SS "Running tests"
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Use AsciiDoc\(cqs HTML5 backend to build HTML manual\&.
+.RE
.sp
-Simply execute the included test runner, which sets up Ruby\(cqs $LOAD_PATH for testing, loads the included test/test_helper\&.rb file, and then evaluates all test/**/*_test\&.rb files:
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Use sans headings and serif content in print style\&.
+.RE
.sp
-.if n \{\
.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
.\}
-.nf
-ruby test/runner
-.fi
-.if n \{\
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Show target URL beside external hyperlinks in print style\&.
.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Show cross\-reference hyperlinks as normal text in print style\&.
+.RE
+.PP
+\fBBug fixes\fR
.sp
-Its exit status will indicate whether all tests have passed\&. It may also print additional pass/fail information depending on the testing library used in the test/test_helper\&.rb file\&.
-.SS "Contributing"
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Admonition icons were not emitted in HTML manual\&.
+.RE
.sp
-\m[blue]\fBFork this project on GitHub\fR\m[] and send a pull request\&.
-.SH "HISTORY"
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Require Rake 0\&.8\&.x because 0\&.9 is incompatible\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Fix undefined method \(oqwrite\(cq for #<Syck::Emitter\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Use
+bundle exec
+to run Ruby and IRB in HACKING\&.
+.RE
+.PP
+\fBHousekeeping\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Emit AsciiDoc attributes in document itself, not on the command line\&.
+\m[blue]\fBhttp://groups\&.google\&.com/group/asciidoc/msg/b4f47a8e1f960018\fR\m[]
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Revert "Reduce font size to accomodate small screens in help manual"\&.
+.RE
.SS "Version 6\&.0\&.2 (2011\-04\-21)"
.sp
This release adopts some common Rails testing and development conventions, drops runtime gem version dependency establishment in favor of [Bundler], produces a gemspec file for greater interoperability, and improves merging\&.
.PP
\fBIncompatible changes\fR
@@ -1202,11 +1302,11 @@
.IP \(bu 2.3
.\}
Allow gem package to be built via
gem build *\&.gemspec
as
-\m[blue]\fBYehuda Katz suggests\fR\m[]\&\s-2\u[3]\d\s+2\&.
+\m[blue]\fBYehuda Katz suggests\fR\m[]\&\s-2\u[2]\d\s+2\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
@@ -1381,11 +1481,11 @@
.IP \(bu 2.3
.\}
Emit hyperlink URLs when rendering the help manual into UNIX manpage format by using xsltproc(1) instead of a2x(1)\&. Thanks to Rainer Müller on the
[AsciiDoc]
mailing list for
-\m[blue]\fBhelping me find the solution\fR\m[]\&\s-2\u[4]\d\s+2
+\m[blue]\fBhelping me find the solution\fR\m[]\&\s-2\u[3]\d\s+2
to this problem\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -1613,11 +1713,11 @@
.sp -1
.IP \(bu 2.3
.\}
Gem version dependencies were not being established in Ruby 1\&.8\&.7 and 1\&.9\&.2 because
Kernel#gem
-\m[blue]\fBis a private method\fR\m[]\&\s-2\u[5]\d\s+2
+\m[blue]\fBis a private method\fR\m[]\&\s-2\u[4]\d\s+2
in those Ruby versions\&.
.sp
To propagate this fix into your projects, please reinitialize them with this version of Inochi\&.
.RE
.SS "Version 4\&.0\&.0 (2010\-07\-25)"
@@ -2181,12 +2281,12 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Put release notes in "description" field of gemspec, as
-\m[blue]\fBsuggested by Eric Hodel\fR\m[]\&\s-2\u[6]\d\s+2, so that subscribers of
-\m[blue]\fBthe RubyForge gems feed\fR\m[]\&\s-2\u[7]\d\s+2
+\m[blue]\fBsuggested by Eric Hodel\fR\m[]\&\s-2\u[5]\d\s+2, so that subscribers of
+\m[blue]\fBthe RubyForge gems feed\fR\m[]\&\s-2\u[6]\d\s+2
are aware of the changes in a published gem\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -2375,13 +2475,13 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
-\m[blue]\fBSDoc\fR\m[]\&\s-2\u[8]\d\s+2
+\m[blue]\fBSDoc\fR\m[]\&\s-2\u[7]\d\s+2
is now used to generate API documentation instead of
-\m[blue]\fBYARD\fR\m[]\&\s-2\u[9]\d\s+2\&. If you link to particular classes or methods in the generated API documentation, be sure to update your link addresses!
+\m[blue]\fBYARD\fR\m[]\&\s-2\u[8]\d\s+2\&. If you link to particular classes or methods in the generated API documentation, be sure to update your link addresses!
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2456,11 +2556,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add "lint" rake task which reports
-\m[blue]\fBcode quality statistics\fR\m[]\&\s-2\u[10]\d\s+2\&.
+\m[blue]\fBcode quality statistics\fR\m[]\&\s-2\u[9]\d\s+2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2479,11 +2579,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add "test:ruby" task which runs all tests with
-\m[blue]\fBmultiruby\fR\m[]\&\s-2\u[11]\d\s+2\&.
+\m[blue]\fBmultiruby\fR\m[]\&\s-2\u[10]\d\s+2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2783,11 +2883,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Added support for unit testing via the
-\m[blue]\fBminitest\fR\m[]\&\s-2\u[12]\d\s+2
+\m[blue]\fBminitest\fR\m[]\&\s-2\u[11]\d\s+2
library\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -2903,11 +3003,11 @@
Inochi
module: project name calculation and CamelCase to snake_case conversion\&.
.RE
.SS "Version 0\&.1\&.0 (2009\-01\-13)"
.sp
-This release reattempts to fix the \m[blue]\fBcircular dependency problem\fR\m[]\&\s-2\u[13]\d\s+2 that occurred when installing either Inochi or ERBook\&.
+This release reattempts to fix the \m[blue]\fBcircular dependency problem\fR\m[]\&\s-2\u[12]\d\s+2 that occurred when installing either Inochi or ERBook\&.
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
@@ -2971,11 +3071,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The name of the project library was
-\m[blue]\fBbeing determined incorrectly\fR\m[]\&\s-2\u[14]\d\s+2\&. (thanks to Florian Gilcher)
+\m[blue]\fBbeing determined incorrectly\fR\m[]\&\s-2\u[13]\d\s+2\&. (thanks to Florian Gilcher)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2983,11 +3083,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
There was a
-\m[blue]\fBcircular dependency problem\fR\m[]\&\s-2\u[13]\d\s+2
+\m[blue]\fBcircular dependency problem\fR\m[]\&\s-2\u[12]\d\s+2
when installing the
Inochi
gem\&. (thanks to Florian Gilcher)
.sp
The solution is to specify the
@@ -3057,11 +3157,11 @@
.RE
.SS "License"
.sp
(the ISC license)
.sp
-Copyright 2008 Suraj N\&. Kurapati <\m[blue]\fBsunaku@gmail\&.com\fR\m[]\&\s-2\u[15]\d\s+2>
+Copyright 2008 Suraj N\&. Kurapati <\m[blue]\fBsunaku@gmail\&.com\fR\m[]\&\s-2\u[14]\d\s+2>
.sp
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies\&.
.sp
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\&. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE\&.
.SH "SEE ALSO"
@@ -3229,74 +3329,69 @@
"Backend Attributes" in the AsciiDoc manual
.RS 4
\%http://www.methods.co.nz/asciidoc/chunked/aph.html
.RE
.IP " 2." 4
-ruby-wrapper
-.RS 4
-\%http://github.com/chneukirchen/rup/blob/master/ruby-wrapper
-.RE
-.IP " 3." 4
Yehuda Katz suggests
.RS 4
\%http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
.RE
-.IP " 4." 4
+.IP " 3." 4
helping me find the solution
.RS 4
\%http://groups.google.com/group/asciidoc/msg/949fae9deb9f86b8
.RE
-.IP " 5." 4
+.IP " 4." 4
is a private method
.RS 4
\%http://redmine.ruby-lang.org/issues/show/3617
.RE
-.IP " 6." 4
+.IP " 5." 4
suggested by Eric Hodel
.RS 4
\%http://www.ruby-forum.com/topic/190220#830072
.RE
-.IP " 7." 4
+.IP " 6." 4
the RubyForge gems feed
.RS 4
\%http://gems.rubyforge.org/index.rss
.RE
-.IP " 8." 4
+.IP " 7." 4
SDoc
.RS 4
\%http://github.com/voloko/sdoc/tree/master
.RE
-.IP " 9." 4
+.IP " 8." 4
YARD
.RS 4
\%http://yard.rubyforge.org
.RE
-.IP "10." 4
+.IP " 9." 4
code quality statistics
.RS 4
\%http://www.infoq.com/news/2008/11/static-analysis-tool-roundup
.RE
-.IP "11." 4
+.IP "10." 4
multiruby
.RS 4
\%http://www.infoq.com/news/2008/02/multiruby-testing
.RE
-.IP "12." 4
+.IP "11." 4
minitest
.RS 4
\%http://rubyforge.org/projects/bfts/
.RE
-.IP "13." 4
+.IP "12." 4
circular dependency problem
.RS 4
\%http://www.ruby-forum.com/topic/176173#771281
.RE
-.IP "14." 4
+.IP "13." 4
being determined incorrectly
.RS 4
\%http://www.ruby-forum.com/topic/176173#771351
.RE
-.IP "15." 4
+.IP "14." 4
sunaku@gmail.com
.RS 4
\%mailto:sunaku@gmail.com
.RE