Builtins RDoc tarball?

G

Gavin Sinclair

Is there a tar.gz that corresponds to
http://www.ruby-doc.org/docs/rdoc/1.9/
which I'm just not seeing?
Click to expand...
If not...how can I get my grubby little hands on a download of it, so I
can stop wasting bandwidth and use it locally?
Click to expand...

I don't know about a tarball, but you can generate it yourself.
Assuming you have the Ruby source, it's not hard.

$ cd <ruby source directory>
$ rdoc
$ <browser> doc/index.html

If you're not happy with the results of that process, it's worth
mentioning here so any issues can be dealt with.

Cheers,
Gavin
 
G

Gavin Kistner

Gavin said:
I don't know about a tarball, but you can generate it yourself.
Assuming you have the Ruby source, it's not hard.

$ cd <ruby source directory>
$ rdoc
$ <browser> doc/index.html

If you're not happy with the results of that process, it's worth
mentioning here so any issues can be dealt with.
Click to expand...

Oh, excellent :)
Building now. OK...here's a not-happy moment:

After many, many minutes of generating all the code, only at the very
end does rdoc inform me that 'doc' already exists, but it doesn't want
to overwrite, so I have to start over and specify a directory.

Suggestions:
* Do the check at the beginning?

* Allow interactive input to let the user type in the name of a
directory here-and-now?

* Cache the parsed information somewhere so a subsequent run doesn't
have to re-'compile' everything?


I'll let you know if it's everything I hoped for once this second run is
complete ;)


Thanks,
 
G

Gavin Kistner

James said:
http://www.ruby-doc.org/downloads/stdlib/
Click to expand...

Er, while that's certainly good stuff, the particular docs I'm looking
for (and building right now per the 'other' Gavin's suggestion) are the
builtin classes, not the standard library. Things like Time and Hash and
Struct and such.

(The similarity of these two concepts has confused me for a moment more
than once in the past.)
 
G

Gavin Kistner

Gavin said:
After many, many minutes of generating all the code, only at the very
end does rdoc inform me that 'doc' already exists, but it doesn't want
to overwrite, so I have to start over and specify a directory.
Click to expand...

Nooooooooooooooooooooooooo!

And the second time I specified a directory in a location that the user
running rdoc didn't have access to.

Grrrrrrrr....
 
G

Gavin Kistner

Gavin said:
$ cd <ruby source directory>
$ rdoc
$ <browser> doc/index.html

If you're not happy with the results of that process, it's worth
mentioning here so any issues can be dealt with.
Click to expand...

Damn...no glory. After 25 minutes of building (with various warnings
sprinkled throughout...see bottom of message) it got to building HTML,
and eventually died with:



/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:419:in
`build_method_detail_list': undefined method `as_href' for nil:NilClass
(NoMethodError)
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:416:in `map'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:416:in
`build_method_detail_list'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:401:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:401:in
`build_method_detail_list'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:399:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:399:in
`build_method_detail_list'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:398:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:398:in
`build_method_detail_list'
... 7 levels...
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1163:in
`generate_html'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1087:in `generate'
from /usr/local/lib/ruby/1.8/rdoc/rdoc.rb:210:in `document'
from /usr/local/bin/rdoc:63





Just in case it's relevant to someone who recognizes this error,
following is the entire 66k output from the run:



[c-24-8-186-129:local/src/ruby-1.8.1] gavinkis% rdoc --op
~/Desktop/builtins
select.c:
fconvert.c:
_round.c:
_dtos18.c:
winsock2.c:
wincemain.c:
wince.c:
time_wce.c:
utime.c:
timeb.c:
stat.c:
string_wce.c:
stdlib.c:
stdio.c:
signal_wce.c:
resource.rb: .
process_wce.c:
mkexports.rb:
mkconfig_wce.rb:
io_wce.c:
errno.c:
direct.c:
assert.c:
winmain.c:
win32.c:
resource.rb: .
mkexports.rb:
version.c:
variable.c:
util.c:
time.c:
test_yaml.rb:
mc........................................................
test_xsd.rb: mc................c...............
test_xmlschemaparser.rb: mc..
test_noencoding.rb: mc..
test_fault.rb: mc..
test_emptycomplextype.rb: mc..
test_raa.rb: mmc........
RAAService.rb: cc.
RAAServant.rb: c......
RAA.rb:
c.....c...................c.......c...........ccc
test_map.rb: mc..
test_datetime.rb: mmc........
DatetimeService.rb: cc.
datetimeServant.rb: c.
datetime.rb:
test_axisarray.rb: mc...
itemList.rb: c...c
test_mailto.rb: mc.....
test_ldap.rb: mc.....
test_http.rb: mc........
test_generic.rb: mc.........
test_ftp.rb: mc...
test_common.rb: mc....
test_procwrapper.rb: mmmc....
test_observable.rb: mmmcc.....
test_backtracefilter.rb: mc..
test_testsuite.rb: mmc...........c..
test_testresult.rb: mmc....
test_testcase.rb: mmc..................................
test_failure.rb: mc.
test_error.rb: mmc.
test_assertions.rb: mmc..........................c......
test_testsuite.rb: mc.....
test_testresult.rb: mc........................
test_testcase.rb: mcc..............
test_assert.rb: mcc...............................
test_objectspace.rb: mmmc............
test_dir.rb:
mmmccc.........c.....................cc.........
test_stringscanner.rb: c.....................
test_stringio.rb: c.
test_streamhandler.rb: mc................
test_soapelement.rb: mc..........
test_property.rb: mc.................
test_basetype.rb: mc.........................
test_struct.rb: mmcc....
test_marshal.rb:
mmmmm....c....cc.ccc....c....c.......cc.cc.........ccc...c...c......c.c.....cc.c.......c....c.c.c....c..c
test_digraph.rb: mmc.c...
cmarshal.rb:
mc.c...c...c...c..c.c...c...c...c...c...c..
test_helloworld.rb: mmc...
hw_s.rb: c..
test_calc_cgi.rb: mmc...
test_calc2.rb: mmc...
test_calc.rb: mmc...
server2.rb: c.
server.rb: c.
calc2.rb: c.......
calc.rb: m....
runner.rb:
ut_eof.rb: m...m...
test_whileuntil.rb: c..
test_variable.rb: cc..c.m.c.
test_trace.rb: c.
test_system.rb: c...
test_struct.rb: c.
test_stringchar.rb: c..
test_signal.rb: c.
test_range.rb: c.
test_proc.rb: c...c.
test_pipe.rb: c.
test_path.rb: c.
test_pack.rb: c.
test_math.rb: c.
test_marshal.rb:
m....c...c...c....c.........c...c...c...c....c......c....cmm.c.c.....c..
test_iterator.rb:
c..c...........c................c........................c..c.c..c.c...........
test_ifunless.rb: c.
test_hash.rb: c..
test_gc.rb: cc..
test_float.rb: c....
test_file.rb: c..
test_exception.rb: c..
test_eval.rb: c..
test_env.rb: c.....
test_defined.rb: cc....
test_const.rb: cmm.
test_condition.rb: c.
test_clone.rb: cmmmmm...
test_case.rb: c.
test_call.rb: c..
test_bignum.rb: c.....
test_beginendblock.rb: c....
test_assignment.rb:
c...................................................................................................................................................
test_array.rb: c.......
test_alias.rb: cc.c.cc....
envutil.rb: m.
endblockwarn.rb: .
beginmainend.rb:
test_ostruct.rb: c.
test_reqarg.rb: mc.c.c.c....
test_placearg.rb: c....
test_optparse.rb: c....
test_optarg.rb: c....
test_noarg.rb: mc.c.....
test_monitor.rb: c.....
test_logger.rb: c.c.c..........cc...c....
test_nowrite.rb: c...........
test_fileutils.rb: c....c......................
fileasserts.rb: mmm.....
ut_timerholder.rb: c...
ut_safe1.rb: .
test/drb/ut_safe1.rb:5:16: Couldn't find ARGV. Assuming it's a module

ut_port.rb: .
test/drb/ut_port.rb:5:16: Couldn't find ARGV. Assuming it's a module

ut_large.rb: c....
test/drb/ut_large.rb:26:16: Couldn't find ARGV. Assuming it's a module

ut_eval.rb: c..
test/drb/ut_eval.rb:12:16: Couldn't find ARGV. Assuming it's a module

ut_drb_drbunix.rb:
test/drb/ut_drb_drbunix.rb:1:60: Skipping require of dynamic string:
"#{File.dirname(File.expand_path(__FILE__))}/ut_drb"
..
test/drb/ut_drb_drbunix.rb:4:16: Couldn't find ARGV. Assuming it's a module

ut_drb_drbssl.rb:
test/drb/ut_drb_drbssl.rb:1:60: Skipping require of dynamic string:
"#{File.dirname(File.expand_path(__FILE__))}/ut_drb"
..
test/drb/ut_drb_drbssl.rb:5:16: Couldn't find ARGV. Assuming it's a module

ut_drb.rb: c.cc.cc.c...................
test/drb/ut_drb.rb:132:16: Couldn't find ARGV. Assuming it's a module

ut_array_drbunix.rb: .
test/drb/ut_array_drbunix.rb:5:16: Couldn't find ARGV. Assuming it's a
module

ut_array_drbssl.rb: .
test/drb/ut_array_drbssl.rb:6:16: Couldn't find ARGV. Assuming it's a module

ut_array.rb: .
test/drb/ut_array.rb:5:16: Couldn't find ARGV. Assuming it's a module

test_drbunix.rb: cc.....c.
test_drbssl.rb: cc.....c.
test_drb.rb:
cc.......c.......cc......cc...c.c.c...c.......
test_acl.rb: c.c.....c......c.....
drbtest.rb: c..c...cc.c.m................m........
test_digest.rb: c....
test_csv.rb:
ccm.c.........c..cc..........................................c..cc.............
struct.c:
string.c:
st.c:
sprintf.c:
signal.c:
soap4r.rb: c.
wsdlDriver.rb: .
sampleClient.rb:
httpd.rb:
GoogleSearchDriver.rb: c..
GoogleSearch.rb:
c.......................c...................ccc.....
wsdlDriver.rb:
sampleClient.rb:
AmazonSearchDriver.rb: c..
AmazonSearch.rb:
cc.....c.........cc.........................................................................................................................cc.....cccccc.....ccc.....ccc.......cc.......ccc.....ccc.................c...c...c...c.....cc.................cc...........cc...cc.............................................c...cc.........c...cc.........................c...................c...................c.................c.....................c.................c...........c...............c...................c.....................c.....................c.....................c.....................c...........c.....................c.............c.............c.................................c...............c.......................c...........ccc...................cc.....cc...........c...........c.............c...........c...............c...............c...............cc.....c.....cc.............cc...............................cc...........c...
uumerge.rb:
tsvr.rb:
trojan.rb:
time.rb:
ts_examples.rb:
tc_subtracter.rb: c...
tc_adder.rb: c...
subtracter.rb: c..
adder.rb: c..
test.rb:
................................................................................................................................................
sample/test.rb:849:23: Warning: yield outside of method
.....c..c.............c.............c.c.c.c.......m.mm..mmmmmc..c.m.cc...c.c.cc...c.
svr.rb:
server.rb: c.
sampleStruct.rb: c.
iSampleStruct.rb: c..c
httpd.rb:
client.rb:
soap4r.rb:
iRAA.rb: mc...c.c.c...cc
IICD.rb: m.
icd.rb:
hw_s.rb: c..
hw_c.rb:
server.rb: c.
httpd.rb:
exchange.rb: c..
client.rb:
digraph.rb: c.
server2.rb: c.
server.rb: c.
httpd.rb:
client2.rb:
client.rb:
calc2.rb: c.......
calc.rb: m....
babelfish.rb:
sieve.rb:
regx.rb:
rcs.rb:
pi.rb:
philos.rb: ....
opttest.rb:
wget.rb:
smime_write.rb:
smime_read.rb:
gen_csr.rb: .
echo_svr.rb:
echo_cli.rb:
crlstore.rb: c............
cipher.rb:
certstore.rb: c...........
cert_store_view.rb:
m....c........................c................c..........c.............cc...........c.........c....................
cert2text.rb: .
c_rehash.rb: c.................
occur2.rb:
occur.rb:
observ.rb: c.c..
mrshtest.rb:
mpart.rb:
mkproto.rb:
mine.rb: c.................
shifting.rb: .
log.rb: .
app.rb: c...
list3.rb: c..
list2.rb: c..
list.rb: c....c...c..
less.rb:
goodfriday.rb: .
fullpath.rb:
from.rb: c...
freq.rb:
fib.rb: .
fact.rb: .
exyacc.rb:
export.rb: c...cc.
eval.rb:
dualstack-httpd.rb:
dualstack-fetch.rb:
dir.rb:
dbmtest.rb:
clnt.rb:
cbreak.rb: ...
cal.rb: .......
biorhythm.rb: .....
rubytest.rb:
ruby.c:
regex.c:
re.c:
rbconfig.rb: m.
range.c:
random.c:
process.c:
prec.c:
parse.c:
pack.c:
object.c:
numeric.c:
mkconfig.rb:
x68.c:
vsnprintf.c:
strtoul.c:
strtol.c:
strtod.c:
strstr.c:
strncasecmp.c:
strftime.c:
strerror.c:
strchr.c:
strcasecmp.c:
os2.c:
mkdir.c:
memmove.c:
memcmp.c:
isnan.c:
isinf.c:
hypot.c:
flock.c:
finite.c:
fileblocks.c:
erf.c:
dup2.c:
crypt.c:
alloca.c:
acosh.c:
mdoc2man.rb: c....
math.c:
marshal.c:
main.c:
yaml.rb: m..................m.
ypath.rb: mc..
yamlnode.rb: mc..
types.rb: mc..c...c....c......c......c.
syck.rb: mmcc
stringio.rb: c.......
lib/yaml/stringio.rb:55:28: Couldn't find YAML. Assuming it's a module
.....
stream.rb: mc.....
store.rb: mc..
rubytypes.rb:
c.c....c...mc.....c..c...c...c...c..c..c..c..c..c..c..c..c..
loader.rb: mc
error.rb: mcc
encoding.rb: m..
emitter.rb: mc........
dbm.rb: mc....................
constants.rb: m
basenode.rb: mm..........
baseemitter.rb: mm..............c.c.
xmlparser.rb: mm..
xmlscanner.rb: mmc.....................
xmlparser.rb: mmcc.
rexmlparser.rb: mmc......
parser.rb: mmccccccc............
qname.rb: mc.........
ns.rb: mcc..c..........
namedelements.rb: mc............
iconvcharset.rb: mc.
datatypes1999.rb: m
datatypes.rb:
mccc...c.....c..c..c..c.....mc....c...c...m.....c....c....c....c....c....c....c....c....c....c....c..c...c..c...c...c...c...
charset.rb: mmcccc..............
utils.rb: mm..m....mc...c...c....m.
server.rb:
mc..............c.....c....c.......c....
parser.rb:
mc.......mc..m.......mc...........................c..m....c.c.c.c.....c.....c.c..c.c.........
marshal.rb: mcc.........
httpserver.rb: c.c..c.c..........
datetime.rb: mc..........
create.rb: mmc..c.....c......c.....
config.rb: mm
client.rb: mc.....................c..
base64.rb: mc.....
unique.rb: mmc...
sequence.rb: mmc.....
schema.rb: mmc......
parser.rb: mmccccccccc..........
import.rb: mmc...
element.rb: mmc....
data.rb: mm
content.rb: mmc........
complexType.rb: mmc.........
complexContent.rb: mmc...
choice.rb: mmc.....
attribute.rb: mmc...
any.rb: mmc....
all.rb: mmc.....
wsdl.rb: mc
types.rb: mc...
operation.rb: mmcc.........
headerfault.rb: mmc...
header.rb: mmc.....
fault.rb: mmc...
definitions.rb: mc..........
data.rb: mm
complexType.rb: mmc......
body.rb: mmc...
binding.rb: mmc...
address.rb: mmc...
service.rb: mc....
portType.rb: mc......
port.rb: mc........
part.rb: mc...
parser.rb: mccccccccc..........
param.rb: mc.....
operationBinding.rb: mc......
operation.rb: mcc...........
message.rb: mc....
info.rb: mc.....
importer.rb: mc....
import.rb: mc....
documentation.rb: mc...
definitions.rb: mc....................
data.rb: m
binding.rb: mc....
webrick.rb:
version.rb: m
utils.rb: mm.....
ssl.rb: mmm.c...
server.rb: mcc.c.c.........
log.rb: mc...............c..
httpversion.rb: mc....
httputils.rb: mm........c.................
httpstatus.rb: mmcccccccc........
httpservlet.rb: mm
prochandler.rb: mmc...
filehandler.rb: mmc.....c...........
erbhandler.rb: mmc...
cgihandler.rb: mmc..
cgi_runner.rb: .
abstract.rb: mmcc.......
httpserver.rb: mcc.........c.......
https.rb: mmc...
httpresponse.rb: mc....................
httprequest.rb: mc....................
httpproxy.rb: mc...........
httpauth.rb: mm...
userdb.rb: mmm...
htpasswd.rb: mmc.......
htgroup.rb: mmc.....
htdigest.rb: mmc.......
digestauth.rb: mmc.............c.
basicauth.rb: mmc....c
authenticator.rb: mmm.....m
htmlutils.rb: mm.
cookie.rb: mc.....
config.rb: mm
compat.rb: mccc
cgi.rb: mc.....c...............
accesslog.rb: mmc..
weakref.rb: cc...
uri.rb: m
mailto.rb: mc..........
ldap.rb: mc.....................
https.rb: mc
http.rb: mc...
generic.rb:
mc....................................................................
ftp.rb: mc........
common.rb: mmmm.m..cccc.....
un.rb: m...........
tsort.rb: mc.......ccc
tracer.rb: cc.............
tmpdir.rb: c.
timeout.rb: mc..
time.rb: cc........c
thwait.rb: c........
thread.rb: cc.c.......c....c........c......
unit.rb: mm..
procwrapper.rb:
lib/test/unit/util/procwrapper.rb:7:0: Unrecognized directive 'nodoc'
mmmc....
observable.rb:
lib/test/unit/util/observable.rb:7:0: Unrecognized directive 'nodoc'
mmmm....
backtracefilter.rb: mmmm.
testrunner.rb:
lib/test/unit/ui/tk/testrunner.rb:9:0: Unrecognized directive 'nodoc'
mmmmc....................
testrunnerutilities.rb:
lib/test/unit/ui/testrunnerutilities.rb:7:0: Unrecognized directive 'nodoc'
mmmm.
testrunnermediator.rb:
lib/test/unit/ui/testrunnermediator.rb:7:0: Unrecognized directive 'nodoc'
mmmc...
testrunner.rb:
lib/test/unit/ui/gtk2/testrunner.rb:7:0: Unrecognized directive 'nodoc'
mmmm
testrunner.rb:
lib/test/unit/ui/gtk/testrunner.rb:7:0: Unrecognized directive 'nodoc'
mmmmc.............................................ccc
testrunner.rb:
lib/test/unit/ui/fox/testrunner.rb:7:0: Unrecognized directive 'nodoc'
mmmmc................................c
testrunner.rb:
lib/test/unit/ui/console/testrunner.rb:7:0: Unrecognized directive 'nodoc'
mmmmc................
testsuite.rb:
lib/test/unit/testsuite.rb:7:0: Unrecognized directive 'nodoc'
mmc........
testresult.rb:
lib/test/unit/testresult.rb:7:0: Unrecognized directive 'nodoc'
mmc.........
testcase.rb:
lib/test/unit/testcase.rb:7:0: Unrecognized directive 'nodoc'
mmc..............
failure.rb:
lib/test/unit/failure.rb:7:0: Unrecognized directive 'nodoc'
mmc.....
error.rb:
lib/test/unit/error.rb:7:0: Unrecognized directive 'nodoc'
mmc......
collector.rb: mmm.....
objectspace.rb: mmmc..
dir.rb: mmmc.....
autorunner.rb: mmc......
assertions.rb:
lib/test/unit/assertions.rb:7:0: Unrecognized directive 'nodoc'
mmm............................c
assertionfailederror.rb:
lib/test/unit/assertionfailederror.rb:7:0: Unrecognized directive 'nodoc'
mmc
tempfile.rb: c........c..
sync.rb: mc.c.c.....c..........c.
wsdlDriver.rb:
mcc....cc............c.................c........
streamHandler.rb: mcc......c.........
soap.rb: mccccccccc..m.
standaloneServer.rb: mmc...........
soaplet.rb: mmc.......c.....c..
rpc.rb: mm.
router.rb: mmc...........
proxy.rb: mmc.c........
element.rb: mc......mcccc.......c......c...c.
driver.rb:
mmccc...................c...............
cgistub.rb: mmccc.....................
property.rb: mc.................................m.
processor.rb: mmc......
parser.rb: mcccccc.................
netHttpClient.rb: mc...........cc.
marshal.rb: mmc....
mapping.rb:
wsdlRegistry.rb: mmc.........
typeMap.rb: m
rubytypeFactory.rb: mmc.....c..........
registry.rb:
mmmmc..c.....ccc.......................c
mapping.rb: mmm................c.
factory.rb:
mmc.............c...c...c...c..c...c...c..c...
generator.rb: mcc..............
soapHandler.rb: mmc...c.c.......................
literalHandler.rb: mmc...c.c...........
handler.rb: mmccc...............
aspDotNetHandler.rb: mmc...c.c...........
element.rb: mmc..........c...c..c...c..
baseData.rb:
mm.mm.m.c......ccccccccccccccccccc..ccccccc...........c.............c....................
singleton.rb: m...cc.c.m.....c..
shellwords.rb: m.
shell.rb: cc......................
version.rb: c
system-command.rb: cc............
process-controller.rb: ccc...................
filter.rb: cc...........
error.rb: cm
command-processor.rb: cc..................................
builtin-command.rb: cc..c..c..c..c..c..c..c..
set.rb:
c...................................c....cc...m.
scanf.rb: mc................c......c...c..m.
topublic.rb: mm
testsuite.rb: mc....
testresult.rb: mc...........
testcase.rb: mc.....
error.rb: m
testrunner.rb: mmc.....c...
assert.rb: mm............
rubyunit.rb:
tuplespace.rb:
mc............c....c.....c....c.......c..........
ring.rb: mc.....c........c..
rinda.rb: mccc.......c..c..c......c..
xpath_parser.rb: mc................
xpath.rb: mc...
xmltokens.rb: mm
xmldecl.rb: mc...........
text.rb: mc.............
streamlistener.rb: mm.............
source.rb: mc.c..........c.......
sax2listener.rb: mm................
rexml.rb: m
quickpath.rb: mc...........
xpathparser.rb: mmc.......................
ultralightparser.rb: mmc...
streamparser.rb: mmc..
sax2parser.rb: mmc.........
pullparser.rb: mmc....c..................
lightparser.rb: mmc...
baseparser.rb: mmc..........
parseexception.rb: mc.....
parent.rb: mc..................
output.rb: mc...
node.rb: mm.....
namespace.rb: mm...
node.rb: mmc.........................
instruction.rb: mc.....
functions.rb:
mm.........................................
entity.rb: mc.......m
UTF-8.rb: mm
UTF-16.rb: mm
US-ASCII.rb: mm
UNILE.rb: mm
SHIFT_JIS.rb: mm..mm..
SHIFT-JIS.rb: mmmm
ISO-8859-1.rb: mm
ICONV.rb: mm
EUC-JP.rb: mmmm
encoding.rb: mm..
element.rb:
mc.......................................c............c............
notationdecl.rb: mmc....
entitydecl.rb: mmc....
elementdecl.rb: mmc.
dtd.rb: mmc..
attlistdecl.rb: mmc
document.rb: mc...............
doctype.rb: mc........c...c.c...c...
comment.rb: mc......
child.rb: mc........
cdata.rb: mc....
attribute.rb: mc.............
attlistdecl.rb: mc......
resolv.rb:
c.............ccc........c..............c...c..c..c..c..c.c..c.cc......ccmmccm.c......c.........c............c..........c..........c..c......c....c...ccc...cc...c...c...c...cmc...c...c...c........c........
resolv-replace.rb: c.c.c.c...c.
readbytes.rb: c.c.
tokenstream.rb: m.....
template.rb: cc.....c........
ri_writer.rb: mc........
ri_util.rb: cc.
ri_reader.rb: mc.........
ri_paths.rb: mm
ri_options.rb: mcm......
ri_formatter.rb: mc.............cc.c........c..c.....
ri_descriptions.rb: mc....cc.c.cc.c...c...c.c
ri_cache.rb: mc.........c...c..c.
rdoc.rb: mcc.....
parserfactory.rb: mm....
parse_simple.rb: mc..
parse_rb.rb:
mc..cc.cc.c.c.c.c...cc.................................mc............................................
parse_f95.rb: mc..c....
parse_c.rb: mc............
options.rb: cm............
TestParse.rb: cc....................
TestInline.rb: c........
AllTests.rb:
simple_markup.rb: mc..........
to_latex.rb: mc.....
to_html.rb: mc........................
to_flow.rb: mmc..c...................
preprocess.rb: mc....
lines.rb: mc.....c..........
inline.rb: mc...c.c...c...c................
fragments.rb: mc.....ccc.ccc.c.c.cc............
sample.rb:
rdoc2latex.rb:
xml_generator.rb: mc...........
xml.rb: mm
rdf.rb: mm
old_html.rb: mm
kilmer.rb: mm.
html.rb: mm
hefss.rb: mm.
chm.rb: mm
ri_generator.rb: mc.c.........
html_generator.rb:
mc...c....m...c.................c..........c.........c.....................c..c...............c..........
chm_generator.rb: mc........
dot.rb: m.c..c...c..c......c......c.c..
diagram.rb: mc........
code_objects.rb:
mc.........c.................................c........c......cccc.c.....c..c.c...c.c.
rational.rb: .c....................c.......c..c..
parser.rb: mcmc........................
pstore.rb: cc............
profiler.rb: m...
profile.rb:
prettyprint.rb:
c.............c...c..c....c....c.......c.................c...c..........c.c...c........
pp.rb:
m.c..cm.......cm....ccc.c..c.cc.c.c.c..c..c..c...ccc.........c.......
ping.rb: m.
pathname.rb:
c....................c.....c..........................c......................c..c........c.c..c..cc
parsedate.rb: m.
parsearg.rb: .....
ostruct.rb: c.....
optparse.rb:
cmcc.c.......c...c.c.c.c.........c..............................................c......ccccccm.c......m
version.rb: c...
uri.rb:
time.rb:
shellwords.rb:
date.rb:
open3.rb: m.
open-uri.rb: m.m.....c.cm.......m..mc.c..c.
observer.rb: m.......
telnet.rb: mc.............
smtp.rb:
mmcccccc................................
protocol.rb: mcccccccccccc......cm
pop.rb:
mcccc...........................c.c.........c
imap.rb:
mc....................................................................cccccc..c..c..c..cc..c...ccccccc
http.rb:
mc....c........c.............c.........m...............m.....................c........c.cccccm.ccccc..cc...................cm
ftp.rb: m
mutex_m.rb: m....c.......
monitor.rb: mcc.....................c
mkmf.rb:
....c.c..m..................................................
matrix.rb:
mc......c....................................cc........................
mathn.rb: c...c...ccc...m..c
mailread.rb: c....
logger.rb:
cccm...................c.........c.......
jcode.rb: c....................
irb.rb: mc......c............
xmp.rb: c..c.....
ws-for-case-2.rb:
workspace.rb: mc....
version.rb: m
slex.rb: cc..........c.....
ruby-token.rb: mc.c.c.c.cc.c.c..
ruby-lex.rb: cc.............................
locale.rb: mc...............
error.rb: m
error.rb: m
input-method.rb: mc...c.....c...c.....
init.rb: m......
help.rb: m.
frame.rb: mc.......
extend-command.rb: mm...
lib/irb/extend-command.rb:105:36: Couldn't find EXCB. Assuming it's a module
...c..cm.
lib/irb/extend-command.rb:194:34: Couldn't find CE. Assuming it's a module
..
workspaces.rb: mc...c.
use-loader.rb: cmm..c..cc
tracer.rb: m.c.c.
multi-irb.rb: mc...............c.
math-mode.rb: mc..
loader.rb: mcm.....
history.rb: mc..c.....
change-ws.rb: mc..c
context.rb: mc...............
completion.rb: mm.
subirb.rb: mmc.c.c.c.
pushws.rb: mmc.c.c.
nop.rb: mmc....
load.rb: mmc.c.c.
fork.rb: mmc.c
chws.rb: mmc.c.
ipaddr.rb:
cc....c.................................
importenv.rb:
gserver.rb: c................
getopts.rb: .
getoptlong.rb: cccccc.........
generator.rb: c..........c.....
ftools.rb: c.........
forwardable.rb: mc..m..
find.rb: m..
finalize.rb: mc............
fileutils.rb:
m......................................mm
eregex.rb: c..c..c..
erb.rb:
c.ccc.c.....c........c.c.c.c.c........c.......cm..cm.
Env.rb:
English.rb:
e2mmap.rb: m.
lib/e2mmap.rb:58:24: Couldn't find E2MM. Assuming it's a module
.....c.....c.c
drb.rb:
unix.rb: mc.........
timeridconv.rb: mccc..........
ssl.rb: mcc..............
observer.rb: mm.
invokemethod.rb: mcm..
gw.rb: mc.c...c..
extservm.rb: mc.........
extserv.rb: mc....c...
eq.rb: mc..
drb.rb:
mccc..m.cccc...c.....c...c.......m.....
lib/drb/drb.rb:765:27: Skipping require of dynamic string: "drb/#{$1}"
c...............mcc........c.....c...................ccc.............
acl.rb: cc....c.......
delegate.rb: c....c.....c...
debug.rb:
c.cc....c....................................c................
date2.rb:
date.rb:
c.....................cc.....c.c......c....................................................c....c....c.cc
format.rb: c......c..
csv.rb:
cc......c.....c..c........c..c....c.......c.......cc...c..........c....
complex.rb:
c.......c.......................m.................
cgi.rb:
c.............c.....m....c...c........mm.....................mmmm.c
cgi-lib.rb: c............
session.rb: cc........c......c.....
pstore.rb: cc.c......
benchmark.rb: m......c..c..c...........
base64.rb: ....
abbrev.rb: m.c
lex.c:
io.c:
instruby.rb: ....
inits.c:
hash.c:
gc.c:
file.c:
zlib.c:
extconf.rb:
win32ole.c:
testWIN32OLE.rb: mmmmc...................c...c..c...
testVARIANT.rb: c.
testOLEVARIABLE.rb: c......
testOLETYPE.rb: c................
testOLEPARAM.rb: c........
testOLEMETHOD.rb: c...............
testOLEEVENT.rb: c...
testall.rb:
oleserver.rb: .m
xml.rb:
m.m....................................mm....m.........m....................................................................m.......................................m.............................................m.......................................m....................................m.............................................m............................................m............................................m.............................................m.......................................m....................................m.......m......................................m.......................................m.............................................c........................................................................c.........................................................................m..............c................c.......mc.............
olegen.rb: c.........................
oledirs.rb: .
ienavi.rb: ...
ieconst.rb: m
ie.rb:
excel3.rb:
excel2.rb:
excel1.rb:
property.rb: c...
extconf.rb: .
Win32API.c:
point.rb:
resolv.rb: mm..
registry.rb:
mcmc.c...m.................................................
getch.rb:
extconf.rb:
tkutil.c:
tktimer3.rb:
tktimer2.rb:
tktimer.rb: .
tktextframe.rb: c....
tkoptdb.rb: c.c
tkoptdb-safeTk.rb:
tkmultilistframe.rb:
c.....................................................
tkmultilistbox.rb: c.....................................
tkmulticolumnlist.rb:
c......................................
tkmenubutton.rb:
tkline.rb: ....
tkhello.rb:
tkfrom.rb: c....
tkdialog.rb: .
tkcombobox.rb: c............c..........
tkbrowse.rb: ..
tkbiff.rb: c......
tkballoonhelp.rb: c........
tkalignbox.rb: c..........c..c.c..c.
safe-tk.rb:
vscale.rb: .
unicodeout.rb: c..
twind.rb: .......
text.rb:
style.rb:
states.rb:
spin.rb:
search.rb: ...
sayings.rb:
ruler.rb: .....
radio2.rb:
radio.rb:
puzzle.rb: ..
plot.rb: ..
paned2.rb:
paned1.rb:
msgbox.rb: .
menubu.rb: .
menu8x.rb:
menu84.rb:
menu.rb:
labelframe.rb: .
label.rb:
items.rb: ........
image3.rb: ...
image2.rb: ..
image1.rb:
icon.rb:
hscale.rb: .
form.rb:
floor.rb: .........
filebox.rb: .
entry3.rb: ....
entry2.rb:
entry1.rb:
dialog2.rb: c.....
dialog1.rb: c.....
ctext.rb: ........
cscroll.rb: ...
colors.rb:
clrpick.rb: ..
check.rb:
button.rb:
bitmap.rb: .
bind.rb: .
arrow.rb: ....
vscale.rb: .
unicodeout.rb: c..
twind.rb: .......
tkencoding.rb: c..m..
text.rb:
style.rb:
states.rb:
spin.rb:
search.rb: ...
sayings.rb:
ruler.rb: .....
radio2.rb:
radio.rb:
puzzle.rb: ..
plot.rb: ..
paned2.rb:
paned1.rb:
msgbox.rb: .
menubu.rb: .
menu84.rb:
menu.rb:
labelframe.rb: .
label.rb:
items.rb: ........
image3.rb: ...
image2.rb: ..
image1.rb:
icon.rb:
hscale.rb: .
form.rb:
floor.rb: .........
filebox.rb: .
entry3.rb: ....
entry2.rb:
entry1.rb:
dialog2.rb: c.....
dialog1.rb: c.....
ctext.rb: ........
cscroll.rb: ...
colors.rb:
clrpick.rb: ..
check.rb:
button.rb:
bitmap.rb: .
bind.rb: .
arrow.rb: ....
tkwinpkg.rb: m.......m......
tkvirtevent.rb: cc.......
tktext.rb:
m..c...........................................................................c......................c..c.c............c..c.c.c.c..........c........
tkscrollbox.rb: c.
tkpalette.rb: m......
tkmngfocus.rb: m.....
tkmenubar.rb: c...
tkmacpkg.rb: m........
tkfont.rb:
cc..............................................................................m.......
tkentry.rb: ccmc..........................c.....
tkdialog.rb: c...............c..c......c..
tkconsole.rb: m....
tkclass.rb: .
tkcanvas.rb:
m..c....................................................m..............................c...........c..c.c.c...c......c.c.c.c.c.c.c.c.c.c........c.c............
tkbgerror.rb: m...
tkafter.rb: c................................
tk.rb: m.
ext/tk/lib/tk.rb:14:15: Couldn't find None. Assuming it's a module
..
ext/tk/lib/tk.rb:25:30: Couldn't find Tk_CMDTBL. Assuming it's a module
..
ext/tk/lib/tk.rb:30:31: Couldn't find Tk_WINDOWS. Assuming it's a module
........................cm....................m.
ext/tk/lib/tk.rb:679:22: Couldn't find INTERP. Assuming it's a module
....................................................m...........m.................m......m...............................mc.....c...c..mm.......cmm.......m....c......c.c...c.............................................c..mm.............m............m........m..................................................................................................m.....m..............m.....mm......c.....c....m.......m.........c..............c............................................................c....c..........c.........c.c...............c..c...c....c..c.c...........c.........c.c.c........m..c..............m..c........................c.m.cccc.cc.................m.....m............
multi-tk.rb:
c..c........c........c.c...c...............c.......c.......c..c...c.c...........c...........c............c.............c..............................................c....cm
extconf.rb:
tcltklib.c:
stubs.c:
sample2.rb: cc.............cc..............
sample1.rb: c...............
sample0.rb: .
tcltk.rb: m......c.......c..c.c.c...c.c...c.
extconf.rb: ..
safeTk.rb:
lines2.rb: .
lines1.rb: .
test.rb: c........
syslog.c:
extconf.rb:
yaml2byte.c:
token.c:
syck.c:
rubyext.c: Enclosing class/module 'rb_syck'
for class Loader not known
Enclosing class/module 'rb_syck' for class Parser not known
Enclosing class/module 'rb_syck' for class Node not known
Enclosing class/module 'rb_syck' for class PrivateType not known
Enclosing class/module 'rb_syck' for class DomainType not known
Enclosing class/module 'rb_syck' for class BadAlias not known
Enclosing class/module 'rb_syck' for class MergeKey not known
Enclosing class/module 'rb_syck' for class DefaultKey not known
Enclosing class/module 'rb_syck' for class Emitter not known

node.c:
implicit.c:
handler.c:
gram.c:
extconf.rb:
emitter.c:
bytecode.c:
strscan.c:
extconf.rb:
stringio.c:
socket.c:
getnameinfo.c:
getaddrinfo.c:
extconf.rb:
testsdbm.rb:
..c.....................................
init.c:
extconf.rb:
_sdbm.c:
readline.c:
extconf.rb:
extconf.rb:
cparse.c:
shl.rb: .
script.rb:
pty.c:
expect.rb: c.
extconf.rb:
expect_sample.rb:
ossl_x509store.c: Enclosing class/module 'mX509' for
class StoreError not known
Enclosing class/module 'mX509' for class Store not known
Enclosing class/module 'mX509' for class StoreContext not known

ossl_x509revoked.c: Enclosing class/module 'mX509' for
class RevokedError not known
Enclosing class/module 'mX509' for class Revoked not known

ossl_x509req.c: Enclosing class/module 'mX509' for
class RequestError not known
Enclosing class/module 'mX509' for class Request not known

ossl_x509name.c: Enclosing class/module 'mX509' for
class NameError not known
Enclosing class/module 'mX509' for class Name not known

ossl_x509ext.c: Enclosing class/module 'mX509' for
class ExtensionError not known
Enclosing class/module 'mX509' for class ExtensionFactory not known
Enclosing class/module 'mX509' for class Extension not known

ossl_x509crl.c: Enclosing class/module 'mX509' for
class CRLError not known
Enclosing class/module 'mX509' for class CRL not known

ossl_x509cert.c: Enclosing class/module 'mX509' for
class CertificateError not known
Enclosing class/module 'mX509' for class Certificate not known

ossl_x509attr.c: Enclosing class/module 'mX509' for
class AttributeError not known
Enclosing class/module 'mX509' for class Attribute not known

ossl_x509.c: Enclosing class/module 'mOSSL' for
module X509 not known

ossl_ssl.c: Enclosing class/module 'mOSSL' for
module SSL not known
Enclosing class/module 'mSSL' for class SSLError not known
Enclosing class/module 'mSSL' for class SSLContext not known
Enclosing class/module 'mSSL' for class SSLSocket not known

ossl_rand.c: Enclosing class/module 'mOSSL' for
module Random not known
Enclosing class/module 'mRandom' for class RandomError not known

ossl_pkey_rsa.c: Enclosing class/module 'mPKey' for
class RSAError not known
Enclosing class/module 'mPKey' for class RSA not known

ossl_pkey_dsa.c: Enclosing class/module 'mPKey' for
class DSAError not known
Enclosing class/module 'mPKey' for class DSA not known

ossl_pkey_dh.c: Enclosing class/module 'mPKey' for
class DHError not known
Enclosing class/module 'mPKey' for class DH not known

ossl_pkey.c: Enclosing class/module 'mOSSL' for
module PKey not known
Enclosing class/module 'mPKey' for class PKeyError not known
Enclosing class/module 'mPKey' for class PKey not known

ossl_pkcs7.c: Enclosing class/module 'mOSSL' for
module PKCS7 not known
Enclosing class/module 'mPKCS7' for class PKCS7Error not known
Enclosing class/module 'mPKCS7' for class PKCS7 not known
Enclosing class/module 'mPKCS7' for class Signer not known

ossl_pkcs12.c: Enclosing class/module 'mOSSL' for
module PKCS12 not known
Enclosing class/module 'mPKCS12' for class PKCS12 not known
Enclosing class/module 'mPKCS12' for class PKCS12Error not known

ossl_ocsp.c: Enclosing class/module 'mOSSL' for
module OCSP not known
Enclosing class/module 'mOCSP' for class OCSPError not known
Enclosing class/module 'mOCSP' for class Request not known
Enclosing class/module 'mOCSP' for class Response not known
Enclosing class/module 'mOCSP' for class BasicResponse not known
Enclosing class/module 'mOCSP' for class CertificateId not known

ossl_ns_spki.c: Enclosing class/module 'mOSSL' for
module Netscape not known
Enclosing class/module 'mNetscape' for class SPKIError not known
Enclosing class/module 'mNetscape' for class SPKI not known

ossl_hmac.c: Enclosing class/module 'mOSSL' for
class HMACError not known
Enclosing class/module 'mOSSL' for class HMAC not known

ossl_engine.c: Enclosing class/module 'mOSSL' for
class Engine not known
Enclosing class/module 'cEngine' for class EngineError not known

ossl_digest.c: Enclosing class/module 'mOSSL' for
module Digest not known
Enclosing class/module 'mDigest' for class DigestError not known
Enclosing class/module 'mDigest' for class Digest not known

ossl_config.c: Enclosing class/module 'mOSSL' for
class ConfigError not known
Enclosing class/module 'mOSSL' for class Config not known

ossl_cipher.c: Enclosing class/module 'mOSSL' for
module Cipher not known
Enclosing class/module 'mOSSL' for class CipherError not known
Enclosing class/module 'mCipher' for class Cipher not known

ossl_bn.c: Enclosing class/module 'mOSSL' for
class BNError not known
Enclosing class/module 'mOSSL' for class BN not known

ossl_bio.c:
ossl_asn1.c: Enclosing class/module 'mOSSL' for
module ASN1 not known
Enclosing class/module 'mASN1' for class ASN1Error not known
Enclosing class/module 'mASN1' for class ASN1Data not known
Enclosing class/module 'mASN1' for class Primitive not known
Enclosing class/module 'mASN1' for class Constructive not known

ossl.c:
openssl_missing.c:
openssl.rb:
x509.rb: mmc....c...c.
ssl.rb: mmm......cc.....
digest.rb: mm
cipher.rb: mmc..
buffering.rb: m.....................
bn.rb: mcc.
telnets.rb: m
protocols.rb: m
https.rb: m
ftptls.rb: m
extconf.rb:
test.rb: ..
nkf.c:
nkf.c:
kconv.rb: m.....c....
extconf.rb:
wait.c:
nonblock.rb: c...
extconf.rb:
iconv.c:
extconf.rb:
charset_alias.rb: c....
testgdbm.rb:
..c.............................................
gdbm.c:
extconf.rb:
fcntl.c:
extmk.rb: ....
extconf.rb:
etc.c:
enumerator.c: Enclosing class/module
'rb_mEnumerable' for class Enumerator not known

type.rb: .....
test.rb: ..m
test.c:
sym.c: Enclosing class/module 'rb_mDL'
for class Symbol not known

stream.rb: m.
msgbox2.rb:
msgbox.rb:
libc.rb: m..
getch.rb:
drives.rb: m
c++sample.rb: cm....
ptr.c: Enclosing class/module 'rb_mDL'
for module MemorySpace not known
Enclosing class/module 'rb_mDL' for class PtrData not known

mkcbtable.rb: .
mkcallback.rb: .
mkcall.rb: .....
win32.rb: c..
types.rb: mc....
struct.rb: mmm..c...c.......c.
import.rb: mmm.............
install.rb: ..
handle.c: Enclosing class/module 'rb_mDL'
for class Handle not known

extconf.rb: ..
ext/dl/extconf.rb:159:15: Couldn't find File. Assuming it's a module

dlconfig.rb:
dl.c:
sha2init.c:
sha2hl.c:
sha2.c:
extconf.rb:
sha1ossl.c:
sha1init.c: Enclosing class/module 'mDigest'
for class SHA1 not known

sha1hl.c:
sha1.c:
extconf.rb:
rmd160ossl.c:
rmd160init.c: Enclosing class/module 'mDigest'
for class RMD160 not known

rmd160hl.c:
rmd160.c:
extconf.rb:
md5ossl.c:
md5init.c: Enclosing class/module 'mDigest'
for class MD5 not known

md5.c:
extconf.rb:
sha1.rb: c.
md5.rb: c.
extconf.rb:
digest.c:
testdbm.rb:
..c......................................
extconf.rb: ..
dbm.c:
view2.rb: ..
view.rb:
rain.rb: ..
mouse.rb: .
hello.rb: .
extconf.rb:
curses.c:
pi.rb:
nlsolve.rb: c.......
linear.rb: .
util.rb: c.c.c..c.
nlsolve.rb: c.......
newton.rb: m..
math.rb: m........
ludcmp.rb: m..
jacobian.rb: m...
extconf.rb:
bigdecimal.c:
eval.c:
error.c:
enum.c:
dmyext.c:
dln.c:
dir.c:
compar.c:
class.c:
bignum.c:
mkexports.rb:
array.c:
Generating HTML...
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:419:in
`build_method_detail_list': undefined method `as_href' for nil:NilClass
(NoMethodError)
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:416:in `map'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:416:in
`build_method_detail_list'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:401:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:401:in
`build_method_detail_list'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:399:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:399:in
`build_method_detail_list'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:398:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:398:in
`build_method_detail_list'
... 7 levels...
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1163:in
`generate_html'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1087:in `generate'
from /usr/local/lib/ruby/1.8/rdoc/rdoc.rb:210:in `document'
from /usr/local/bin/rdoc:63
 
G

Gavin Sinclair

And the second time I specified a directory in a location that the user
running rdoc didn't have access to.
Click to expand...
Grrrrrrrr....
Click to expand...

:)

I guess it's generally safest to just plonk it in './rdoc', which you
must be able to access since you (presumably) unpacked the source code
right where you are anyway.

Once it's there, you can take the risk with other directories.

Good points, though. RDoc should definitely check its output
directory as early as possible.

Gavin
 
J

James Britt

Gavin said:
Er, while that's certainly good stuff, the particular docs I'm looking
for (and building right now per the 'other' Gavin's suggestion) are the
builtin classes, not the standard library. Things like Time and Hash and
Struct and such.
Click to expand...

Um, er, duh.

I ran Rdoc on CVS source. I can tar it, though, and provide a link.
(The similarity of these two concepts has confused me for a moment more
than once in the past.)
Click to expand...


Understandable.


James
 
G

Gavin Sinclair

G

Gavin Kistner

James said:
Try here:
http://www.ruby-doc.org/downloads
Click to expand...

Am I missing somewhere in there which has the builtin (aka Core API)
library rdoc? 'cause I don't see it.


I'm repeatedly failing to find this data on my own. If I do:

rdoc time.c

in the source directory, I get a listing of all of Time's methods, but
none of the documentation for those methods which is present in:
http://www.ruby-doc.org/docs/rdoc/1.9/classes/Time.html

Indeed, none of the 'time*' files that I can find in the source
directory seem to generate such output. (The above url lists time.c and
lib/time.rb as the location files, but rdoc'ing both of those together
doesn't get me descriptions of the methods.)


In fact...here we go:

The start of
http://www.ruby-doc.org/docs/rdoc/1.9/classes/Time.html#M000185
says:
"Creates a new time object with the value given by ..."

But when I search for that phrase in the entire source directory, I get
nothing:

root# grep -r 'a new time object' /usr/local/src/ruby-1.8.1/*
root#


So the question remains...where is ruby-doc.org getting its information?
A custom version of the source with all comments included?
Customized files meticulously self-documented?
 
D

Dave Thomas

I'm repeatedly failing to find this data on my own. If I do:

rdoc time.c

in the source directory, I get a listing of all of Time's methods, but
none of the documentation for those methods which is present in:
http://www.ruby-doc.org/docs/rdoc/1.9/classes/Time.html
Click to expand...

Look in the source file for time.c: can you see comments containing the
documentation in front of the C methods that implement the class's
public interface? If not, you're probably looking at an old version of
the source.


Cheers

Dave
 
G

Gavin Kistner

Look in the source file for time.c: can you see comments containing
the documentation in front of the C methods that implement the class's
public interface? If not, you're probably looking at an old version of
the source.
Click to expand...

That was the case, where 'old' is 1.8.1, and not a 1.9 snapshot.

Getting 1.9 for rdoc building did the trick. (Or rather, I can see the
methods of Time now. I'm still fighting to find out what file(s) are
causing rdoc to crash when writing the output) Thanks :)


While I've got you here...is there a way to get rdoc to document
multiple call sequences for a method in a .rb file? I tried mimicking
the style seen in time.c:

/*
* call-seq:
* Time.at( aTime ) => time
* Time.at( seconds [, microseconds] ) => time

But putting that same sort of code in myfile.rb:

# call-seq:
# MutableTime.foo( a )
# MutableTime.foo( b )

...failed to produce the same results.
 
G

Gavin Kistner

Gavin said:
Getting 1.9 for rdoc building did the trick. (Or rather, I can see the
methods of Time now. I'm still fighting to find out what file(s) are
causing rdoc to crash when writing the output) Thanks :)
Click to expand...

Amazingly, I'm still fighting this. Here's the latest output (using rdoc
from 1.8.1 on the latest snapshot sources):

ruby-snapshot_20040218] root# rdoc --op rdoc *.c *.rb

array.c:
[...]
instruby.rb: .....
mdoc2man.rb: c....
mkconfig.rb:
rubytest.rb:
runruby.rb:
Generating HTML...
/usr/local/lib/ruby/1.8/rdoc/code_objects.rb:334:in `find_symbol'
*** malloc: vm_allocate(size=2147483648) failed (error code=3)
*** malloc[1195]: error: Can't allocate region
*** malloc: vm_allocate(size=2147483648) failed (error code=3)
*** malloc[1195]: error: Can't allocate region
: undefined method `find_local_symbol' for #<RDoc::AnyMethod:0x3cb118>
(NoMethodError)
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1015:in
`find_symbol'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:116:in
`handle_special_CROSSREF'
from
/usr/local/lib/ruby/1.8/rdoc/markup/simple_markup/to_html.rb:226:in `send'
from
/usr/local/lib/ruby/1.8/rdoc/markup/simple_markup/to_html.rb:226:in
`convert_special'
from
/usr/local/lib/ruby/1.8/rdoc/markup/simple_markup/to_html.rb:223:in
`each_name_of'
from
/usr/local/lib/ruby/1.8/rdoc/markup/simple_markup/inline.rb:32:in `each'
from
/usr/local/lib/ruby/1.8/rdoc/markup/simple_markup/inline.rb:32:in
`each_name_of'
from
/usr/local/lib/ruby/1.8/rdoc/markup/simple_markup/to_html.rb:223:in
`convert_special'
... 24 levels...
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1168:in
`generate_html'
from
/usr/local/lib/ruby/1.8/rdoc/generators/html_generator.rb:1092:in `generate'
from /usr/local/lib/ruby/1.8/rdoc/rdoc.rb:210:in `document'
from /usr/local/bin/rdoc:63
 
G

Gavin Sinclair

That was the case, where 'old' is 1.8.1, and not a 1.9 snapshot.
Click to expand...

Yes, unfortunately 1.8.1 just missed the boat on the core API documentation
front. Still, that means it should be tried and tested in time for
1.8.2.
Getting 1.9 for rdoc building did the trick. (Or rather, I can see the
methods of Time now. I'm still fighting to find out what file(s) are
causing rdoc to crash when writing the output) Thanks :)
Click to expand...

Thanks for the persistence. We need to shake these problems out.

While I've got you here...is there a way to get rdoc to document
multiple call sequences for a method in a .rb file? I tried mimicking
the style seen in time.c:
Click to expand...
/*
* call-seq:
* Time.at( aTime ) => time
* Time.at( seconds [, microseconds] ) => time
Click to expand...
But putting that same sort of code in myfile.rb:
Click to expand...
# call-seq:
# MutableTime.foo( a )
# MutableTime.foo( b )
Click to expand...
...failed to produce the same results.
Click to expand...

No, it's a C workaround. RDoc can't parse an adequate method header
from C code, because default parameters are done indirectly, and maybe
other reasons.

I'd rather all methods look the same in RDoc output, and that the
'sameness' be modelled on the way Ruby is parsed. I can see the
benefit in the case of Time.at, above, but...

(OTOH, I'm grateful that RDoc can understand C at all...)

Cheers,
Gavin
 
G

Gavin Sinclair

Amazingly, I'm still fighting this. Here's the latest output (using rdoc
from 1.8.1 on the latest snapshot sources):
Click to expand...
[errors snipped]
Click to expand...

Hmmmm, ugly. I'll let Dave read the entrails, but I'll just suggest
that you use the latest RDoc version. Yes, that means building Ruby
all over again, unless you roll your own RDoc installer :)

There's been significant work on the software as well as the
documentation since 1.8.1, I believe.

Gavin
 
D

Dave Thomas

That was the case, where 'old' is 1.8.1, and not a 1.9 snapshot.
Click to expand...

The 1.8 branch in CVS has them too.
While I've got you here...is there a way to get rdoc to document
multiple call sequences for a method in a .rb file? I tried mimicking
the style seen in time.c:
Click to expand...

Not currently. Is that something that would be generally useful?

Cheers

Dave
 
D

Dave Thomas

ruby-snapshot_20040218] root# rdoc --op rdoc *.c *.rb

array.c:
[...]
instruby.rb: .....
mdoc2man.rb: c....
mkconfig.rb:
rubytest.rb:
runruby.rb:
Generating HTML...
/usr/local/lib/ruby/1.8/rdoc/code_objects.rb:334:in `find_symbol'
*** malloc: vm_allocate(size=2147483648) failed (error code=3)
*** malloc[1195]: error: Can't allocate region
*** malloc: vm_allocate(size=2147483648) failed (error code=3)
*** malloc[1195]: error: Can't allocate region
Click to expand...

I don't know about the rest of your problems, but the above seem to me
to be an interpreter problem.

In the meantime, you probably don't want to document the .rb files in
the main ruby directory. Just type

rdoc --op rdoc

and let it work out what to document.


Cheers


Dave
 
G

Gavin Kistner

In the meantime, you probably don't want to document the .rb files in
the main ruby directory. Just type

rdoc --op rdoc

and let it work out what to document.
Click to expand...

Trying that takes 20 minutes a pop and has failed in the past. I was
attempting to pare down and see if it was a particular file that was
borked.

Anyhow, I'm now following Mr. Sinclair's advice and going to rebuild
Ruby with the latest stable snapshot, and see if the rdoc provided by
that fares any better.

(The same error occurred when I ran it on just *.c in the main
directory, FWIW.)
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Similar Threads

[ANN] RDoc 3 6
rdoc and Rake::RDocTask with different outputs? 0
rdoc doesn't recognize block comments anymore 1
rdoc files: how to read them? 2
RDoc 1.9 hangs 1
RDoc : hyperlinked names of classes 0
Does Darkfish-Rdoc work properly? 1
RDoc 2.4.3 - :call-seq: ignored? 0

Members online

No members online now.
Total: 51 (members: 0, guests: 51)
Robots: 211

Forum statistics

Threads
473,764
Messages
2,569,567
Members
45,041
Latest member
RomeoFarnh

Latest Threads

Top