man/man1/inochi.1 in inochi-5.1.0 vs man/man1/inochi.1 in inochi-6.0.0
- old
+ new
@@ -1,16 +1,25 @@
'\" t
.\" Title: inochi
.\" Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 2010-08-14
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2011-04-21
.\" Manual: \ \&
-.\" Source: \ \& 5.1.0
+.\" Source: \ \& 6.0.0
.\" Language: English
.\"
-.TH "INOCHI" "1" "2010\-08\-14" "\ \& 5\&.1\&.0" "\ \&"
+.TH "INOCHI" "1" "2011\-04\-21" "\ \& 6\&.0\&.0" "\ \&"
.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -356,33 +365,33 @@
.\}
.nf
class TestWordCount < Test::Unit::TestCase
def test_handles_empty_input
assert_equal(0, WordCount\&.count(nil))
- assert_equal(0, WordCount\&.count(\'\'))
- assert_equal(0, WordCount\&.count(\' \'))
+ assert_equal(0, WordCount\&.count(\*(Aq\*(Aq))
+ assert_equal(0, WordCount\&.count(\*(Aq \*(Aq))
end
def test_handles_single_words
- assert_equal(1, WordCount\&.count(\'a\'))
- assert_equal(1, WordCount\&.count(\'foo\'))
- assert_equal(1, WordCount\&.count(\'bar\'))
+ assert_equal(1, WordCount\&.count(\*(Aqa\*(Aq))
+ assert_equal(1, WordCount\&.count(\*(Aqfoo\*(Aq))
+ assert_equal(1, WordCount\&.count(\*(Aqbar\*(Aq))
end
def test_handles_multiple_words
- assert_equal(2, WordCount\&.count(\'a b\'))
- assert_equal(2, WordCount\&.count(\'a\-b\'))
- assert_equal(2, WordCount\&.count(\'a/b\'))
+ assert_equal(2, WordCount\&.count(\*(Aqa b\*(Aq))
+ assert_equal(2, WordCount\&.count(\*(Aqa\-b\*(Aq))
+ assert_equal(2, WordCount\&.count(\*(Aqa/b\*(Aq))
end
def test_ignores_punctuation_and_space
- assert_equal(0, WordCount\&.count(\'!\'))
- assert_equal(0, WordCount\&.count(\'! @ # % #!@#\'))
- assert_equal(0, WordCount\&.count(\' !\'))
- assert_equal(0, WordCount\&.count(\'! \'))
- assert_equal(0, WordCount\&.count(\' ! \'))
- assert_equal(0, WordCount\&.count(\' ! \'))
+ assert_equal(0, WordCount\&.count(\*(Aq!\*(Aq))
+ assert_equal(0, WordCount\&.count(\*(Aq! @ # % #!@#\*(Aq))
+ assert_equal(0, WordCount\&.count(\*(Aq !\*(Aq))
+ assert_equal(0, WordCount\&.count(\*(Aq! \*(Aq))
+ assert_equal(0, WordCount\&.count(\*(Aq ! \*(Aq))
+ assert_equal(0, WordCount\&.count(\*(Aq ! \*(Aq))
end
end
.fi
.if n \{\
.RE
@@ -473,10 +482,11 @@
lt lt
lt lt
lt lt
lt lt
lt lt
+lt lt
lt lt.
T{
.sp
ann
T}:T{
@@ -532,10 +542,17 @@
.sp
Build release package for RubyGems\&.
T}
T{
.sp
+gem:spec
+T}:T{
+.sp
+Build RubyGems package specification\&.
+T}
+T{
+.sp
init
T}:T{
.sp
Instill Inochi into current directory\&.
T}
@@ -660,10 +677,11 @@
#!/bin/sh
old=$1; new=$2; out=$3;
# meld "$new" "$out" # use meld
# tkdiff "$old" "$new" \-o "$out" # use tkdiff
# kdiff3 \-\-merge "$old" "$new" \-\-output "$out" # use kdiff3
+# diffuse "$old" "$out" "$new" # use diffuse
.fi
.if n \{\
.RE
.\}
.RE
@@ -878,18 +896,18 @@
.if n \{\
.RS 4
.\}
.nf
:gem_spec_logic: |
- # show the Inochi\-provided specification for this project\'s gem
+ # show the Inochi\-provided specification for this project\*(Aqs gem
puts gem\&.to_ruby
# add files that are outside this project directory to the gem
- gem\&.files += [\'some\', \'files\', \'in\', \'this\', \'directory\']
+ gem\&.files += [\*(Aqsome\*(Aq, \*(Aqfiles\*(Aq, \*(Aqin\*(Aq, \*(Aqthis\*(Aq, \*(Aqdirectory\*(Aq]
- # omit some added files in this project\'s directory from the gem
- gem\&.files \-= [\'lib/top_secret\&.rb\', \'bin/more_top_secret_stuff\']
+ # omit some added files in this project\*(Aqs directory from the gem
+ gem\&.files \-= [\*(Aqlib/top_secret\&.rb\*(Aq, \*(Aqbin/more_top_secret_stuff\*(Aq]
# and so on\&.\&.\&. anything is possible! use your imagination!
.fi
.if n \{\
.RE
@@ -919,16 +937,13 @@
.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/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"
@@ -1003,17 +1018,17 @@
.sp
You may choose to omit some or all of these components by simply not mentioning them in the "Resources" section of the help manual\(cqs README source file\&.
.SH "HACKING"
.SS "Prerequisites"
.sp
-Install Ruby libraries necessary for development:
+Install Ruby libraries necessary for development using [Bundler]:
.sp
.if n \{\
.RS 4
.\}
.nf
-gem install inochi \-\-development
+bundle install
.fi
.if n \{\
.RE
.\}
.SS "Infrastructure"
@@ -1095,11 +1110,11 @@
.if n \{\
.RE
.\}
.SS "Running tests"
.sp
-Simply execute the included test runner, which sets up Ruby\(cqs $LOAD_PATH for testing, loads the test/helper\&.rb file, and then evaluates all test/**/*_test\&.rb files:
+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 n \{\
.RS 4
.\}
.nf
@@ -1107,15 +1122,158 @@
.fi
.if n \{\
.RE
.\}
.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/helper\&.rb file\&.
+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
\m[blue]\fBFork this project on GitHub\fR\m[] and send a pull request\&.
.SH "HISTORY"
+.SS "Version 6\&.0\&.0 (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
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Remove runtime gem version dependency establishment from
+lib/*/inochi\&.rb\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Replace
+DEVTIME
+constant in
+lib/*/inochi\&.rb
+with
+[Bundler]\*(Aqs Gemfile\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Rename
+RUNTIME
+constant to
+GEMDEPS
+in
+lib/*/inochi\&.rb\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Rename
+test/helper\&.rb
+to
+test/test_helper\&.rb
+per Rails convention\&.
+.RE
+.PP
+\fBNew features\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Add
+gem:spec
+task to generate a gemspec file for your project\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.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\&.
+.RE
+.PP
+\fBBug fixes\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Make old and new files read\-only before merging\&.
+.RE
+.PP
+\fBDocumentation\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Add diffuse tool to the example merge2 script\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Reduce font size to accomodate small screens\&.
+.RE
+.PP
+\fBHousekeeping\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Omit CREDITS file from gem: help manual already includes it\&.
+.RE
.SS "Version 5\&.1\&.0 (2010\-08\-14)"
.sp
This release uses [Pygments] for syntax highlighting, adds icons to admonitions, speeds up the \fBpub:web\fR task, and further refines the HTML version of your project\(cqs help manual\&.
.PP
\fBNew features\fR
@@ -1219,11 +1377,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[3]\d\s+2
+\m[blue]\fBhelping me find the solution\fR\m[]\&\s-2\u[4]\d\s+2
to this problem\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -1451,11 +1609,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[4]\d\s+2
+\m[blue]\fBis a private method\fR\m[]\&\s-2\u[5]\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)"
@@ -1756,12 +1914,12 @@
.if n \{\
.RS 4
.\}
.nf
inochi aborted!
-Don\'t know how to build task \'\'
-/usr/lib/ruby/gems/1\&.9\&.1/gems/rake\-0\&.8\&.7/lib/rake\&.rb:1728:in `[]\'
+Don\*(Aqt know how to build task \*(Aq\*(Aq
+/usr/lib/ruby/gems/1\&.9\&.1/gems/rake\-0\&.8\&.7/lib/rake\&.rb:1728:in `[]\*(Aq
(See full trace by running task with \-\-trace)
.fi
.if n \{\
.RE
.\}
@@ -2019,12 +2177,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[5]\d\s+2, so that subscribers of
-\m[blue]\fBthe RubyForge gems feed\fR\m[]\&\s-2\u[6]\d\s+2
+\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
are aware of the changes in a published gem\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -2043,11 +2201,11 @@
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
-Change file extension of generated user manuals from \&.xhtml to \&.html to accomodate Microsoft web browsers\' inability to process the application/xhtml+xml mime type\&.
+Change file extension of generated user manuals from \&.xhtml to \&.html to accomodate Microsoft web browsers\*(Aq inability to process the application/xhtml+xml mime type\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
@@ -2213,13 +2371,13 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
-\m[blue]\fBSDoc\fR\m[]\&\s-2\u[7]\d\s+2
+\m[blue]\fBSDoc\fR\m[]\&\s-2\u[8]\d\s+2
is now used to generate API documentation instead of
-\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!
+\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!
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2294,11 +2452,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add "lint" rake task which reports
-\m[blue]\fBcode quality statistics\fR\m[]\&\s-2\u[9]\d\s+2\&.
+\m[blue]\fBcode quality statistics\fR\m[]\&\s-2\u[10]\d\s+2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2317,11 +2475,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[10]\d\s+2\&.
+\m[blue]\fBmultiruby\fR\m[]\&\s-2\u[11]\d\s+2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2521,13 +2679,13 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
In Windows,
-ENV[\'USERPROFILE\']
+ENV[\*(AqUSERPROFILE\*(Aq]
gives the path to the user\(cqs home directory and
-ENV[\'HOME\']
+ENV[\*(AqHOME\*(Aq]
is not defined\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -2547,11 +2705,11 @@
.fi
.if n \{\
.RE
.\}
.sp
-You should update the "Setup" section in your projects\' user manuals accordingly\&.
+You should update the "Setup" section in your projects\*(Aq user manuals accordingly\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
@@ -2621,11 +2779,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Added support for unit testing via the
-\m[blue]\fBminitest\fR\m[]\&\s-2\u[11]\d\s+2
+\m[blue]\fBminitest\fR\m[]\&\s-2\u[12]\d\s+2
library\&.
.RE
.sp
.RS 4
.ie n \{\
@@ -2673,11 +2831,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Allow project authors to be specified via
-Inochi\&.init :YourProject, :authors => [[\'name\', \'mail\']]
+Inochi\&.init :YourProject, :authors => [[\*(Aqname\*(Aq, \*(Aqmail\*(Aq]]
(thanks to Florian Gilcher)
.RE
.PP
\fBBug fixes\fR
.sp
@@ -2741,11 +2899,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[12]\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[13]\d\s+2 that occurred when installing either Inochi or ERBook\&.
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
@@ -2809,11 +2967,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[13]\d\s+2\&. (thanks to Florian Gilcher)
+\m[blue]\fBbeing determined incorrectly\fR\m[]\&\s-2\u[14]\d\s+2\&. (thanks to Florian Gilcher)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
@@ -2821,11 +2979,11 @@
.el \{\
.sp -1
.IP \(bu 2.3
.\}
There was a
-\m[blue]\fBcircular dependency problem\fR\m[]\&\s-2\u[12]\d\s+2
+\m[blue]\fBcircular dependency problem\fR\m[]\&\s-2\u[13]\d\s+2
when installing the
Inochi
gem\&. (thanks to Florian Gilcher)
.sp
The solution is to specify the
@@ -2895,11 +3053,11 @@
.RE
.SS "License"
.sp
(the ISC license)
.sp
-Copyright 2008 Suraj N\&. Kurapati <\m[blue]\fBsunaku@gmail\&.com\fR\m[]\&\s-2\u[14]\d\s+2>
+Copyright 2008 Suraj N\&. Kurapati <\m[blue]\fBsunaku@gmail\&.com\fR\m[]\&\s-2\u[15]\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"
@@ -2923,20 +3081,28 @@
lt lt
lt lt
lt lt
lt lt
lt lt
+lt lt
lt lt.
T{
.sp
[AsciiDoc]
T}:T{
.sp
\m[blue]\fBhttp://www\&.methods\&.co\&.nz/asciidoc/\fR\m[]
T}
T{
.sp
+[Bundler]
+T}:T{
+.sp
+\m[blue]\fBhttp://gembundler\&.com\fR\m[]
+T}
+T{
+.sp
[Ember]
T}:T{
.sp
\m[blue]\fBhttp://snk\&.tuxfamily\&.org/lib/ember/\fR\m[]
T}
@@ -3064,64 +3230,69 @@
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
helping me find the solution
.RS 4
\%http://groups.google.com/group/asciidoc/msg/949fae9deb9f86b8
.RE
-.IP " 4." 4
+.IP " 5." 4
is a private method
.RS 4
\%http://redmine.ruby-lang.org/issues/show/3617
.RE
-.IP " 5." 4
+.IP " 6." 4
suggested by Eric Hodel
.RS 4
\%http://www.ruby-forum.com/topic/190220#830072
.RE
-.IP " 6." 4
+.IP " 7." 4
the RubyForge gems feed
.RS 4
\%http://gems.rubyforge.org/index.rss
.RE
-.IP " 7." 4
+.IP " 8." 4
SDoc
.RS 4
\%http://github.com/voloko/sdoc/tree/master
.RE
-.IP " 8." 4
+.IP " 9." 4
YARD
.RS 4
\%http://yard.rubyforge.org
.RE
-.IP " 9." 4
+.IP "10." 4
code quality statistics
.RS 4
\%http://www.infoq.com/news/2008/11/static-analysis-tool-roundup
.RE
-.IP "10." 4
+.IP "11." 4
multiruby
.RS 4
\%http://www.infoq.com/news/2008/02/multiruby-testing
.RE
-.IP "11." 4
+.IP "12." 4
minitest
.RS 4
\%http://rubyforge.org/projects/bfts/
.RE
-.IP "12." 4
+.IP "13." 4
circular dependency problem
.RS 4
\%http://www.ruby-forum.com/topic/176173#771281
.RE
-.IP "13." 4
+.IP "14." 4
being determined incorrectly
.RS 4
\%http://www.ruby-forum.com/topic/176173#771351
.RE
-.IP "14." 4
+.IP "15." 4
sunaku@gmail.com
.RS 4
\%mailto:sunaku@gmail.com
.RE