Bug #5598

man pages are in mdoc format

Added by ro (Rainer Orth) 7 months ago. Updated 6 months ago.

[ruby-core:40844]
Status:Closed Start date:11/08/2011
Priority:Normal Due date:
Assignee:yugui (Yuki Sonoda) % Done:

100%
Category:DOC
Target version:1.9.2
ruby -v:ruby 1.9.2p290 (2011-07-09 revision 32553) [sparc-solaris2.10]

Description

Unfortunately, the ruby man pages are in mdoc format (as detected by grog). The Solaris man/nroff commands cannot deal with that format, rendering the man pages effectively useless. Please provide them using only man macros instead so they are universally useful.

p-mantype.diff - patch common.mk to always pass --mantype="$(MANTYPE)" (2.7 kB) kernigh (George Koehler), 11/24/2011 07:29 am

Related issues

related to Backport93 - Backport #5682: Backport r33886 (convert mdoc to man properly) Closed 11/29/2011

Associated revisions

Revision 33886
Added by yugui (Yuki Sonoda) 6 months ago

* common.mk (INSTRUBY_ARGS): added --mantype to apply mdoc2man.rb to man pages. Fixes #5598. (do-install-nodoc, do-install-local, do-install-man, dont-install-nodoc, dont-install-local, dont-install-man): No longer needs --mantype. Reported by Rainer Orth <ro AT cebitec.uni-bielefeld.de>, patch by George Koehler <xkernigh AT netscape.net>.

History

[ruby-core:40871]#1
Updated by nobu (Nobuyoshi Nakada) 7 months ago

  • Category set to DOC
  • Status changed from Open to Feedback
Doesn't `make install MANTYPE=man' work?

[ruby-core:41263]#2
Updated by kernigh (George Koehler) 6 months ago

Ruby should use its tool/mdoc2man.rb to convert mdoc format to man format. This is broken because some targets in Makefile forgot to pass --mantype="$(MANTYPE)" to INSTRUBY (tools/rbinstall.rb). Now `make install' and `make install-all' ignore MANTYPE and always install mdoc format. I attached a quick patch. It moves --mantype="$(MANTYPE)" into INSTRUBY_ARGS, so every install target always passes MANTYPE.

[ruby-core:41328]#3
Updated by yugui (Yuki Sonoda) 6 months ago

  • Status changed from Feedback to Assigned
  • Assignee set to yugui (Yuki Sonoda)
  • Target version set to 1.9.2

HI George,

Thank you for your patch. I'll take a look at this issue.

#4
Updated by yugui (Yuki Sonoda) 6 months ago

  • Status changed from Assigned to Closed
  • % Done changed from 0 to 100
This issue was solved with changeset r33886. Rainer, thank you for reporting this issue. Your contribution to Ruby is greatly appreciated. May Ruby be with you. ---------- * common.mk (INSTRUBY_ARGS): added --mantype to apply mdoc2man.rb to man pages. Fixes #5598. (do-install-nodoc, do-install-local, do-install-man, dont-install-nodoc, dont-install-local, dont-install-man): No longer needs --mantype. Reported by Rainer Orth <ro AT cebitec.uni-bielefeld.de>, patch by George Koehler <xkernigh AT netscape.net>.

Also available in: Atom PDF