Re: a ruby-core primer

On 8/24/06, Dave Howell <[e-mail]> wrote:
>
> I endorse somebody else's suggestion of adding links to the "Using CVS"
> section. I didn't get any error messages, so I guess it worked
> correctly, but I have absolutely no idea what was actually happening.
> Poof! Mysterious magic.



Well, assuming you ended up with a bunch of files, it probably worked.


> Well enough. On to ruby/lib/rdoc. Yup, looks a lot like my 1.8.4
> version. First, I figure I should RDoc the RDoc directory, so I have
> documentation that matches the actual code.


[ Travails deleted ]

Take me, for instance. Hey, I want to help, but what I want to do is
> add text to the code. Not add/fix/change code (by which I mean RUBY
> code, although I'm sure I'll end up doing some of that, too), but text.



In that case, I'd say forget about building 1.9. You don't need it.

I do all my RDoc writing using the 1.9 sources checked out from cvs, but I
use the 1.8 rdoc I already have to generate the documentation, check the
stuff I add works and results in good looking pages, and so on.

Then when I'm done I use cvs diff to generate the updates as a patch, and
shoot them off to someone on the ruby-doc list who can check them for sanity
and actually apply them.

Really, once you've mastered the initial checkout there are three commands
you need to worry about: cvs diff, cvs update (once a week or so to keep up
to date) and rdoc. OS X should have workable versions of cvs and rdoc, in
fact 10.4 has rdoc even if you haven't installed the developer tools. Other
than that, you just need to know how to edit a text file.

I'd suggest heading over to ruby-doc for more help on this topic.


mathew
-- 
<URL:http://www.pobox.com/~meta/>