Project

General

Profile

Bug #5598

man pages are in mdoc format

Added by ro (Rainer Orth) about 8 years ago. Updated about 8 years ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
ruby 1.9.2p290 (2011-07-09 revision 32553) [sparc-solaris2.10]
Backport:
[ruby-core:40844]

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.


Files

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

Related issues

Related to Backport193 - Backport #5682: Backport r33886 (convert mdoc to man properly)Closed11/29/2011Actions

Associated revisions

Revision 0f7e05a0
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33886 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 33886
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Revision 33886
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Revision 33886
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Revision 33886
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Revision 33886
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Revision 33886
Added by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Revision 15090079
Added by naruse (Yui NARUSE) almost 8 years ago

merge revision(s) 33886: [Backport #5682]

    * 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>.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_3@34448 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

History

Updated by nobu (Nobuyoshi Nakada) about 8 years ago

  • Category set to doc
  • Status changed from Open to Feedback

Doesn't `make install MANTYPE=man' work?

Updated by kernigh (George Koehler) about 8 years 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' andmake 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.

Updated by yugui (Yuki Sonoda) about 8 years ago

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

=begin
HI George,

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

#4

Updated by yugui (Yuki Sonoda) about 8 years 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 ,
patch by George Koehler .

Also available in: Atom PDF