Project

General

Profile

Actions

Feature #7712

closed

Add .txt extensions to all plain-text documentation files for Windows users

Added by postmodern (Hal Brodigan) about 11 years ago. Updated almost 11 years ago.

Status:
Rejected
Assignee:
-
Target version:
[ruby-core:51499]

Description

Given that Ruby is now aiming for Windows 8 support, all plain-text documentation files should have a .txt extension. This allows Windows users to easily open the files; since Windows relies on the file extension to determine which app to open the file with. For files that contain RDoc formatting, add a .rdoc extension. This proposed change does not conflict with GNU Coding Standards [1], which only specifies the required names of project files and not their extensions.

Files to rename:

  • sample/README (.txt)
  • spec/README (.rdoc)
  • COPYING (.txt)
  • ChangeLog (.txt)
  • GPL (.txt)
  • README (.txt)
  • doc/ChangeLog-YARV (.txt)
  • doc/pty/README (.txt)
  • doc/rake/README (.rdoc)
  • doc/rake/CHANGES (.rdoc)
  • doc/rubygems/README (.rodc)
  • NEWS (.rdoc)
  • test/rdoc/README (.txt) (only contains "you don't have to" ??)
  • BSDL (.txt)
  • README.EXT (.txt)
  • symbian/README.SYMBIAN (.rdoc)
  • LEGAL (.txt)
  • lib/README (.txt)
  • misc/README (.txt)
  • ext/stringio/README (.rdoc)
  • ext/bigdecimal/README (.txt)
  • ext/gdbm/README (.txt)
  • ext/racc/cparse/README (.rdoc)
  • ext/ripper/README (.rdoc)
  • ext/tk/sample/demos-en/README (.txt)
  • ext/tk/sample/demos-en/doc.org/README.JP (.txt)
  • ext/tk/sample/demos-en/doc.org/README (.txt)
  • ext/tk/sample/tkextlib/tkHTML/README (.txt)
  • ext/tk/sample/msgs_tk/README (.txt)
  • ext/tk/sample/msgs_rb2/README (.txt)
  • ext/tk/sample/demos-jp/README (.txt)
  • ext/tk/sample/demos-jp/doc.org/README.JP (.txt)
  • ext/tk/sample/demos-jp/doc.org/README (.txt)
  • ext/tk/sample/msgs_rb/README (.txt)
  • ext/tk/lib/README (.txt)
  • ext/tk/lib/tkextlib/tkimg/README (.txt)
  • ext/tk/lib/tkextlib/tcllib/README (.txt)
  • ext/tk/lib/tkextlib/SUPPORT_STATUS (.txt)
  • ext/readline/README (.txt)

[1]; http://www.gnu.org/prep/standards/html_node/Documentation.html#Documentation

Actions

Also available in: Atom PDF

Like0
Like0Like0Like0Like0Like0Like0Like0Like0