Project

General

Profile

Bug #10860

tool/mdoc2man.rb doesn't handle man/rake.1 correctly

Added by jeremyevans0 (Jeremy Evans) almost 5 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
-
ruby -v:
ruby 2.2.0p0 (2014-12-25 revision 49005) [x86_64-openbsd]
[ruby-core:68156]

Description

Before r48658, rake.1 was in mdoc format, and tool/mdoc2man.rb handled it correctly. In r48658, rake.1 was switched to man format, and tool/mdoc2man.rb doesn't handle it correctly, resulting in a broken manual page. Either tool/rbinstall.rb should be modified not to run tool/mdoc2man.rb on rake.1, or tool/mdoc2man.rb should be improved to handle man format without modification.

Alternatively, r48658 could be reverted, putting rake.1 back in mdoc format, and then rake.1 could be updated to reflect the new options to rake. However, I don't see that as a good option unless the upstream rake developers are open to changing rake.1 manual format from man to mdoc.

Note that this isn't a issue if --with-mantype=doc is passed to ./configure or if ./configure determines that mdoc format is supported.

Any change should probably be backported to 2.2, but not earlier versions, as rake.1 uses mdoc format in earlier versions.

History

Updated by anjbe (Anthony Bentley) almost 5 years ago

Jeremy Evans wrote:

Alternatively, r48658 could be reverted, putting rake.1 back in mdoc format, and then rake.1 could be updated to reflect the new options to rake. However, I don't see that as a good option unless the upstream rake developers are open to changing rake.1 manual format from man to mdoc.

I opened a pull request that converts rake.1 to mdoc. We'll see how upstream feels about it.

https://github.com/ruby/rake/pull/24

Updated by jeremyevans0 (Jeremy Evans) over 4 years ago

This can be closed, as rake.1 was removed recently.

Updated by usa (Usaku NAKAMURA) over 4 years ago

  • Status changed from Open to Closed

Also available in: Atom PDF