[前][次][番号順一覧][スレッド一覧]

ruby-changes:46298

From: stomar <ko1@a...>
Date: Thu, 20 Apr 2017 16:46:26 +0900 (JST)
Subject: [ruby-changes:46298] stomar:r58411 (trunk): improve man pages

stomar	2017-04-20 16:46:22 +0900 (Thu, 20 Apr 2017)

  New Revision: 58411

  https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=58411

  Log:
    improve man pages
    
    * man/ruby.1, man/erb.1, man/goruby.1, man/irb.1:
      fix document title formatting and volume name,
      improve "REPORTING BUGS" section: fix mdoc formatting error
      (wrong macro for bullet list items), small rewordings.

  Modified files:
    trunk/man/erb.1
    trunk/man/goruby.1
    trunk/man/irb.1
    trunk/man/ruby.1
Index: man/irb.1
===================================================================
--- man/irb.1	(revision 58410)
+++ man/irb.1	(revision 58411)
@@ -1,6 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/man/irb.1#L1
 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@n...>.
 .Dd November 15, 2012
-.Dt IRB(1) "" "Ruby Programmers Reference Guide"
+.Dt IRB \&1 "Ruby Programmer's Reference Guide"
 .Os UNIX
 .Sh NAME
 .Nm irb
@@ -159,15 +159,17 @@ Personal irb initialization. https://github.com/ruby/ruby/blob/trunk/man/irb.1#L159
 .Pp
 .Sh REPORTING BUGS
 .Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
-.Aq security@r... .
+.It
+Security vulnerabilities should be reported via an email to
+.Mt security@r... .
 Reported problems will be published after being fixed.
 .Pp
-.Li And you can report other bugs and feature requests via the
+.It
+Other bugs and feature requests can be reported via the
 Ruby Issue Tracking System
 .Pq Lk https://bugs.ruby-lang.org/ .
 Do not report security vulnerabilities
-via the system because it publishes the vulnerabilities immediately.
+via this system because it publishes the vulnerabilities immediately.
 .El
 .Sh AUTHORS
 Written by Keiju ISHITSUKA.
Index: man/ruby.1
===================================================================
--- man/ruby.1	(revision 58410)
+++ man/ruby.1	(revision 58411)
@@ -1,7 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/man/ruby.1#L1
 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@n...>.
 .Dd October 31, 2015
-.Dt RUBY(1) "" "Ruby Programmers Reference Guide"
-.\".Dt RUBY 1
+.Dt RUBY \&1 "Ruby Programmer's Reference Guide"
 .Os UNIX
 .Sh NAME
 .Nm ruby
@@ -641,15 +640,17 @@ Comprehensive catalog of Ruby libraries. https://github.com/ruby/ruby/blob/trunk/man/ruby.1#L640
 .Pp
 .Sh REPORTING BUGS
 .Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
-.Aq security@r... .
-Reported problems will be published after they've been fixed.
+.It
+Security vulnerabilities should be reported via an email to
+.Mt security@r... .
+Reported problems will be published after being fixed.
 .Pp
-.Li And you can report other bugs and feature requests via the
+.It
+Other bugs and feature requests can be reported via the
 Ruby Issue Tracking System
 .Pq Lk https://bugs.ruby-lang.org/ .
 Do not report security vulnerabilities
-via the system because it publishes the vulnerabilities immediately.
+via this system because it publishes the vulnerabilities immediately.
 .El
 .Sh AUTHORS
 Ruby is designed and implemented by
Index: man/goruby.1
===================================================================
--- man/goruby.1	(revision 58410)
+++ man/goruby.1	(revision 58411)
@@ -1,6 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/man/goruby.1#L1
 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@n...>.
 .Dd November 15, 2012
-.Dt GORUBY(1) "" "Ruby Programmers Reference Guide"
+.Dt GORUBY \&1 "Ruby Programmer's Reference Guide"
 .Os UNIX
 .Sh NAME
 .Nm goruby
Index: man/erb.1
===================================================================
--- man/erb.1	(revision 58410)
+++ man/erb.1	(revision 58411)
@@ -1,6 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/man/erb.1#L1
 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@n...>.
 .Dd November 15, 2012
-.Dt ERB(1) "" "Ruby Programmers Reference Guide"
+.Dt ERB \&1 "Ruby Programmer's Reference Guide"
 .Os UNIX
 .Sh NAME
 .Nm erb
@@ -143,15 +143,17 @@ class. https://github.com/ruby/ruby/blob/trunk/man/erb.1#L143
 .Pp
 .Sh REPORTING BUGS
 .Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
-.Aq security@r... .
+.It
+Security vulnerabilities should be reported via an email to
+.Mt security@r... .
 Reported problems will be published after being fixed.
 .Pp
-.Li And you can report other bugs and feature requests via the
+.It
+Other bugs and feature requests can be reported via the
 Ruby Issue Tracking System
 .Pq Lk https://bugs.ruby-lang.org/ .
 Do not report security vulnerabilities
-via the system because it publishes the vulnerabilities immediately.
+via this system because it publishes the vulnerabilities immediately.
 .El
 .Sh AUTHORS
 Written by Masatoshi SEKI.

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]