Bug #10161: C API docs not generated properly without baseruby

• Status: Closed
• Assignee: -
• Target version: -
• ruby -v: ruby 2.0.0p481 (2014-05-08 revision 45883) [amd64-freebsd11]
• Backport: 2.0.0: DONE, 2.1: DONE

[swills (Steve Wills)]

In 1.9.x, the C API docs would be generated properly even if you didn't have ruby installed first. However, this has changed in 2.0.0 and 2.1.x.

Because lines 44-50 of configure.in expect baseruby to exist or set it to "echo executable host ruby is required....", I think the lines at the top of template/Doxyfile.tmpl don't work and so you end up with FILE_VERSION_FILTER and INPUT_FILTER set to "echo executable host ruby is required....", which causes the doxygen docs to be generated without the "Modules" and "Data Structures" tabs. This makes the docs far less useful.

In 1.9.x, baseruby isn't checked to exist at build time, FILE_VERSION_FILTER and INPUT_FILTER end up set to miniruby and all works fine.

There are several ways to fix this, either changing configure.in, changing template/Doxyfile.tmpl etc.

[nobu (Nobuyoshi Nakada)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

Applied in changeset r47248.

---

tool/vcs.rb: no time.rb

• common.mk (Doxyfile): revert r43888, not to require preinstalled
  ruby. [ruby-core:64488] [Bug #10161]

[swills (Steve Wills)]

Thanks for the quick fix. I was looking at the commit, and wondering, did something perhaps unrelated slip into the commit accidentally? Or maybe I'm just not understanding how the changes to tool/file2lastrev.rb and tool/vcs.rb are related?

[nobu (Nobuyoshi Nakada)]

• Backport changed from 2.0.0: UNKNOWN, 2.1: UNKNOWN to 2.0.0: REQUIRED, 2.1: REQUIRED

As time.rb requires date.so, tool/vcs.rb couldn't work on miniruby, which can't load extension libraries.
Now tool/vcs.rb doesn't require time.rb, so tool/file2lastrev.rb works in pure ruby.

[nagachika (Tomoyuki Chikanaga)]

• Backport changed from 2.0.0: REQUIRED, 2.1: REQUIRED to 2.0.0: REQUIRED, 2.1: DONE

Backported into ruby_2_1 branch at r47518.

[usa (Usaku NAKAMURA)]

• Backport changed from 2.0.0: REQUIRED, 2.1: DONE to 2.0.0: DONE, 2.1: DONE

backported into ruby_2_0_0 at r47546.