読者です 読者をやめる 読者になる 読者になる

RDocのアップデート

RDocをアップデートする

Rubyと一緒にインストールされたRDocのバージョンが古いので、

# rdoc --version
RDoc V1.0.1 - 20041108

最新版にアップデートします。

# gem install rdoc
NOTE: If you are running Ruby 1.9.2 you can ignore this message.

RDoc 2.5+ has a new ri data format for Ruby 1.8.7 and 1.9.1.  (1.9.2 contains
RDoc 2.5 so there is nothing to do!)

To install new ri data for core and stdlib you'll need to:

  gem install rdoc-data

then run:

  rdoc-data --install

To have ri data for you gems you'll also need to run:

  gem rdoc --all --overwrite

If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.

NOTE:  RDoc 2.5 did not save method parameters, so you should upgrade your
rdoc-data gem to a version >= 2.5.3 if you installed an older version.
Successfully installed rdoc-3.5.3
1 gem installed
Installing ri documentation for rdoc-3.5.3...
Installing RDoc documentation for rdoc-3.5.3...

1.0.1から3.5.3にアップデートされました。途中、“Rubyのコアと標準ライブラリについて、更新されたriのデータがあるから、必要ならインストールしてね(To install new ri data for core and stdlib you'll need to)”というメッセージが表示されています。

早速、rdoc-dataをインストールします。まずはrdoc-dataをダウンロードして、

# gem install rdoc-data
RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data
gem to a version >= 2.5.3.

To have ri data for core and stdlib you'll need to:

  gem install rdoc-data

then run:

  rdoc-data --install

To have ri data for you gems you'll also need to run:

  gem rdoc --all --overwrite

If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
To install ri data for RDoc 2.5+ run:

  rdoc-data

Successfully installed rdoc-2.5.11
Successfully installed rdoc-data-2.5.3
2 gems installed
Installing ri documentation for rdoc-2.5.11...
Installing ri documentation for rdoc-data-2.5.3...
Installing RDoc documentation for rdoc-2.5.11...
Installing RDoc documentation for rdoc-data-2.5.3...

表示に従ってインストールします。

# rdoc-data --install

無事にアップデートされました。

# rdoc --version
rdoc 3.5.3



毎回指定するオプションを環境変数に設定する

文字コードのように、毎回指定するオプションは環境変数RDOCOPTに設定しましょう。rdocコマンドの実行時にはRDOCOPTに設定されたオプションが自動的に適用されるため、コマンドラインオプションの記述を省略することができます。

FILE: ~/.bash_profile

export RDOCOPT="-c UTF8"