ruby-changes:43492
From: normal <ko1@a...>
Date: Sun, 3 Jul 2016 06:01:14 +0900 (JST)
Subject: [ruby-changes:43492] normal:r55564 (trunk): tool: add descriptions and fix typos
normal 2016-07-03 06:01:04 +0900 (Sun, 03 Jul 2016) New Revision: 55564 https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=55564 Log: tool: add descriptions and fix typos * tool/asm_parse.rb: add description * tool/change_maker.rb: ditto * tool/downloader.rb: ditto * tool/eval.rb: ditto * tool/expand-config.rb: ditto * tool/extlibs.rb: ditto * tool/fake.rb: ditto * tool/file2lastrev.rb: ditto * tool/gem-unpack.rb: ditto * tool/gen_dummy_probes.rb: ditto * tool/gen_ruby_tapset.rb: ditto * tool/generic_erb.rb: ditto * tool/id2token.rb: ditto * tool/ifchange: ditto * tool/insns2vm.rb: ditto * tool/instruction.rb: ditto * tool/jisx0208.rb: ditto * tool/merger.rb: ditto * tool/mkrunnable.rb: ditto * tool/node_name.rb: ditto * tool/parse.rb: ditto * tool/rbinstall.rb: ditto * tool/rbuninstall.rb: ditto * tool/rmdirs: ditto * tool/runruby.rb: ditto * tool/strip-rdoc.rb: ditto * tool/vcs.rb: ditto * tool/vtlh.rb: ditto * tool/ytab.sed: ditto * tool/enc-unicode.rb: fix typo * tool/mk_call_iseq_optimized.rb: ditto * tool/update-deps: ditto [ruby-core:76215] [Bug #12539] by Noah Gibbs <the.codefolio.guy@g...> Modified files: trunk/ChangeLog trunk/tool/asm_parse.rb trunk/tool/change_maker.rb trunk/tool/downloader.rb trunk/tool/enc-unicode.rb trunk/tool/eval.rb trunk/tool/expand-config.rb trunk/tool/extlibs.rb trunk/tool/fake.rb trunk/tool/file2lastrev.rb trunk/tool/gem-unpack.rb trunk/tool/gen_dummy_probes.rb trunk/tool/gen_ruby_tapset.rb trunk/tool/generic_erb.rb trunk/tool/id2token.rb trunk/tool/ifchange trunk/tool/insns2vm.rb trunk/tool/instruction.rb trunk/tool/jisx0208.rb trunk/tool/merger.rb trunk/tool/mk_call_iseq_optimized.rb trunk/tool/mkrunnable.rb trunk/tool/node_name.rb trunk/tool/parse.rb trunk/tool/rbinstall.rb trunk/tool/rbuninstall.rb trunk/tool/rmdirs trunk/tool/runruby.rb trunk/tool/strip-rdoc.rb trunk/tool/update-deps trunk/tool/vcs.rb trunk/tool/vtlh.rb trunk/tool/ytab.sed Index: tool/insns2vm.rb =================================================================== --- tool/insns2vm.rb (revision 55563) +++ tool/insns2vm.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/insns2vm.rb#L1 #!ruby +# This is used by Makefile.in to generate .inc files. +# See Makefile.in for details. + require 'optparse' Version = %w$Revision: 11626 $[1..-1] Index: tool/expand-config.rb =================================================================== --- tool/expand-config.rb (revision 55563) +++ tool/expand-config.rb (revision 55564) @@ -1,5 +1,7 @@ https://github.com/ruby/ruby/blob/trunk/tool/expand-config.rb#L1 #!./miniruby -s +# Used to expand Ruby config entries for Win32 Makefiles. + config = File.read(conffile = $config) config.sub!(/^(\s*)RUBY_VERSION\b.*(\sor\s*)$/, '\1true\2') rbconfig = Module.new {module_eval(config, conffile)}::RbConfig Index: tool/strip-rdoc.rb =================================================================== --- tool/strip-rdoc.rb (revision 55563) +++ tool/strip-rdoc.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/strip-rdoc.rb#L1 #!ruby +# Filter for preventing Doxygen from processing RDoc comments. +# Used by the Doxygen template. + ARGF.binmode source = ARGF.read source = source.gsub(%r{/\*([!*])((?!\*/).+?)\*/}m) do |comment| Index: tool/gem-unpack.rb =================================================================== --- tool/gem-unpack.rb (revision 55563) +++ tool/gem-unpack.rb (revision 55564) @@ -1,6 +1,9 @@ https://github.com/ruby/ruby/blob/trunk/tool/gem-unpack.rb#L1 require 'rubygems' require 'rubygems/package' +# This library is used by "make extract-gems" to +# unpack bundled gem files. + def Gem.unpack(file, dir = nil) policy = Gem::Security::LowSecurity (policy = policy.dup).ui = Gem::SilentUI.new Index: tool/eval.rb =================================================================== --- tool/eval.rb (revision 55563) +++ tool/eval.rb (revision 55564) @@ -1,3 +1,4 @@ https://github.com/ruby/ruby/blob/trunk/tool/eval.rb#L1 +# VM checking and benchmarking code require './rbconfig' require 'fileutils' Index: tool/jisx0208.rb =================================================================== --- tool/jisx0208.rb (revision 55563) +++ tool/jisx0208.rb (revision 55564) @@ -1,3 +1,5 @@ https://github.com/ruby/ruby/blob/trunk/tool/jisx0208.rb#L1 +# Library used by tools/enc-emoji-citrus-gen.rb + module JISX0208 class Char class << self Index: tool/rbinstall.rb =================================================================== --- tool/rbinstall.rb (revision 55563) +++ tool/rbinstall.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/rbinstall.rb#L1 #!./miniruby +# Used by the "make install" target to install Ruby. +# See common.mk for more details. + begin load "./rbconfig.rb" rescue LoadError Index: tool/vcs.rb =================================================================== --- tool/vcs.rb (revision 55563) +++ tool/vcs.rb (revision 55564) @@ -1,6 +1,9 @@ https://github.com/ruby/ruby/blob/trunk/tool/vcs.rb#L1 # vcs require 'fileutils' +# This library is used by several other tools/ scripts to detect the current +# VCS in use (e.g. SVN, Git) or to interact with that VCS. + ENV.delete('PWD') unless File.respond_to? :realpath Index: tool/rbuninstall.rb =================================================================== --- tool/rbuninstall.rb (revision 55563) +++ tool/rbuninstall.rb (revision 55564) @@ -1,4 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/rbuninstall.rb#L1 #! /usr/bin/ruby -nl + +# Used by the "make uninstall" target to uninstall Ruby. +# See common.mk for more details. + BEGIN { $dryrun = false $tty = STDOUT.tty? Index: tool/gen_dummy_probes.rb =================================================================== --- tool/gen_dummy_probes.rb (revision 55563) +++ tool/gen_dummy_probes.rb (revision 55564) @@ -1,6 +1,9 @@ https://github.com/ruby/ruby/blob/trunk/tool/gen_dummy_probes.rb#L1 #!/usr/bin/ruby # -*- coding: us-ascii -*- +# Used to create dummy probes (as for systemtap and DTrace) by Makefiles. +# See common.mk. + text = ARGF.read # remove comments Index: tool/downloader.rb =================================================================== --- tool/downloader.rb (revision 55563) +++ tool/downloader.rb (revision 55564) @@ -1,3 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/tool/downloader.rb#L1 +# Used by configure and make to download or update mirrored Ruby and GCC +# files. This will use HTTPS if possible, falling back to HTTP. + require 'open-uri' begin require 'net/https' Index: tool/file2lastrev.rb =================================================================== --- tool/file2lastrev.rb (revision 55563) +++ tool/file2lastrev.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/file2lastrev.rb#L1 #!/usr/bin/env ruby +# Gets the most recent revision of a file in a VCS-agnostic way. +# Used by Doxygen, Makefiles and merger.rb. + require 'optparse' # this file run with BASERUBY, which may be older than 1.9, so no Index: tool/ifchange =================================================================== --- tool/ifchange (revision 55563) +++ tool/ifchange (revision 55564) @@ -1,6 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/ifchange#L1 #!/bin/sh # usage: ifchange target temporary +# Used in generating revision.h via Makefiles. + set -e timestamp= keepsuffix= Index: tool/change_maker.rb =================================================================== --- tool/change_maker.rb (revision 55563) +++ tool/change_maker.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/change_maker.rb#L1 #! ./miniruby +# Used by "make change" to generate a list of files for a Changelog entry. +# Run it via "make change" in the Ruby root directory. + $:.unshift(File.expand_path("../../lib", __FILE__)) require File.expand_path("../vcs", __FILE__) Index: tool/ytab.sed =================================================================== --- tool/ytab.sed (revision 55563) +++ tool/ytab.sed (revision 55564) @@ -1,4 +1,5 @@ https://github.com/ruby/ruby/blob/trunk/tool/ytab.sed#L1 #!/bin/sed -f +# This file is used when generating code for the Ruby parser. /^int yydebug;/{ i\ #ifndef yydebug Index: tool/mk_call_iseq_optimized.rb =================================================================== --- tool/mk_call_iseq_optimized.rb (revision 55563) +++ tool/mk_call_iseq_optimized.rb (revision 55564) @@ -4,7 +4,7 @@ puts <<EOS https://github.com/ruby/ruby/blob/trunk/tool/mk_call_iseq_optimized.rb#L4 /* DO NOT EDIT THIS FILE DIRECTLY * - * This file is enerated by tool/mkcall_iseq.rb + * This file is generated by tool/mkcall_iseq.rb */ EOS Index: tool/parse.rb =================================================================== --- tool/parse.rb (revision 55563) +++ tool/parse.rb (revision 55564) @@ -1,3 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/tool/parse.rb#L1 +# Used as part of the "make parse" Makefile target. +# See common.mk for details. + $file = ARGV[0] $str = ARGF.read.sub(/^__END__.*\z/m, '') puts '# ' + '-' * 70 Index: tool/vtlh.rb =================================================================== --- tool/vtlh.rb (revision 55563) +++ tool/vtlh.rb (revision 55564) @@ -1,3 +1,5 @@ https://github.com/ruby/ruby/blob/trunk/tool/vtlh.rb#L1 +# Convert addresses to line numbers for MiniRuby. + # ARGF = open('ha') cd = `pwd`.chomp + '/' ARGF.each{|line| Index: tool/id2token.rb =================================================================== --- tool/id2token.rb (revision 55563) +++ tool/id2token.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/id2token.rb#L1 #! /usr/bin/ruby -p # -*- coding: us-ascii -*- + +# Used to build the Ruby parsing code in common.mk and Ripper. + BEGIN { require 'optparse' $:.unshift(File.dirname(__FILE__)) Index: tool/instruction.rb =================================================================== --- tool/instruction.rb (revision 55563) +++ tool/instruction.rb (revision 55564) @@ -1,7 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/instruction.rb#L1 #!./miniruby # -*- coding: us-ascii -*- # -# +# This library is used by insns2vm.rb as part of autogenerating +# instruction files with .inc extensions like insns.inc and vm.inc. require 'erb' $:.unshift(File.dirname(__FILE__)) Index: tool/merger.rb =================================================================== --- tool/merger.rb (revision 55563) +++ tool/merger.rb (revision 55564) @@ -3,7 +3,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/merger.rb#L3 exec "${RUBY-ruby}" "-x" "$0" "$@" && [ ] if false #!ruby # This needs ruby 1.9 and subversion. -# run this in a repository to commit. +# As a Ruby committer, run this in an SVN repository +# to commit a change. require 'fileutils' require 'tempfile' Index: tool/node_name.rb =================================================================== --- tool/node_name.rb (revision 55563) +++ tool/node_name.rb (revision 55564) @@ -1,4 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/node_name.rb#L1 #! ./miniruby + +# Used when making Ruby to generate node_name.inc. +# See common.mk for details. + while gets if ~/enum node_type \{/..~/^\};/ ~/(NODE_.+),/ and puts(" case #{$1}:\n\treturn \"#{$1}\";") Index: tool/enc-unicode.rb =================================================================== --- tool/enc-unicode.rb (revision 55563) +++ tool/enc-unicode.rb (revision 55564) @@ -1,6 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/tool/enc-unicode.rb#L1 #!/usr/bin/env ruby -# Creates the data structures needed by Onigurma to map Unicode codepoints to +# Creates the data structures needed by Oniguruma to map Unicode codepoints to # property names and POSIX character classes # # To use this, get UnicodeData.txt, Scripts.txt, PropList.txt, Index: tool/gen_ruby_tapset.rb =================================================================== --- tool/gen_ruby_tapset.rb (revision 55563) +++ tool/gen_ruby_tapset.rb (revision 55564) @@ -1,5 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/tool/gen_ruby_tapset.rb#L1 #!/usr/bin/ruby # -*- coding: us-ascii -*- +# Create a tapset for systemtap and DTrace # usage: ./ruby gen_ruby_tapset.rb --ruby-path=/path/to/ruby probes.d > output require "optparse" Index: tool/rmdirs =================================================================== --- tool/rmdirs (revision 55563) +++ tool/rmdirs (revision 55564) @@ -1,4 +1,7 @@ https://github.com/ruby/ruby/blob/trunk/tool/rmdirs#L1 #!/bin/sh + +# Script used by configure to delete directories recursively. + for dir do while rmdir "$dir" >/dev/null 2>&1 && parent=`expr "$dir" : '\(.*\)/[^/][^/]*'`; do Index: tool/mkrunnable.rb =================================================================== --- tool/mkrunnable.rb (revision 55563) +++ tool/mkrunnable.rb (revision 55564) @@ -1,6 +1,9 @@ https://github.com/ruby/ruby/blob/trunk/tool/mkrunnable.rb#L1 #!./miniruby # -*- coding: us-ascii -*- +# Used by "make runnable" target, to make symbolic links from a build +# directory. + require './rbconfig' require 'fileutils' Index: tool/generic_erb.rb =================================================================== --- tool/generic_erb.rb (revision 55563) +++ tool/generic_erb.rb (revision 55564) @@ -1,4 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/generic_erb.rb#L1 # -*- coding: us-ascii -*- + +# Used to expand Ruby template files by common.mk, uncommon.mk and +# some Ruby extension libraries. + require 'erb' require 'optparse' require 'fileutils' Index: tool/fake.rb =================================================================== --- tool/fake.rb (revision 55563) +++ tool/fake.rb (revision 55564) @@ -1,3 +1,6 @@ https://github.com/ruby/ruby/blob/trunk/tool/fake.rb#L1 +# Used by Makefile and configure for building Ruby. +# See common.mk and Makefile.in for details. + class File sep = ("\\" if RUBY_PLATFORM =~ /mswin|bccwin|mingw/) if sep != ALT_SEPARATOR Index: tool/runruby.rb =================================================================== --- tool/runruby.rb (revision 55563) +++ tool/runruby.rb (revision 55564) @@ -1,5 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/runruby.rb#L1 #!./miniruby +# Used by "make runruby", configure, and by hand to run a locally-built Ruby +# with correct environment variables and arguments. + show = false precommand = [] while arg = ARGV[0] Index: tool/update-deps =================================================================== --- tool/update-deps (revision 55563) +++ tool/update-deps (revision 55564) @@ -28,7 +28,7 @@ require 'pathname' https://github.com/ruby/ruby/blob/trunk/tool/update-deps#L28 require 'open3' require 'pp' -# When out-of-place bulid, files may be built in source directory or +# When out-of-place build, files may be built in source directory or # build directory. # Some files are always built in the source directory. # Some files are always built in the build directory. Index: tool/asm_parse.rb =================================================================== --- tool/asm_parse.rb (revision 55563) +++ tool/asm_parse.rb (revision 55564) @@ -1,3 +1,5 @@ https://github.com/ruby/ruby/blob/trunk/tool/asm_parse.rb#L1 +# YARV tool to parse assembly output. + stat = {} while line = ARGF.gets Index: tool/extlibs.rb =================================================================== --- tool/extlibs.rb (revision 55563) +++ tool/extlibs.rb (revision 55564) @@ -1,4 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/tool/extlibs.rb#L1 #!/usr/bin/ruby + +# Used to download, extract and patch extension libraries (extlibs) +# for Ruby. See common.mk for Ruby's usage. + require 'fileutils' require 'digest' require_relative 'downloader' Index: ChangeLog =================================================================== --- ChangeLog (revision 55563) +++ ChangeLog (revision 55564) @@ -1,3 +1,40 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1 +Sun Jul 3 05:25:46 2016 Eric Wong <e@8...> + + * tool/asm_parse.rb: add description + * tool/change_maker.rb: ditto + * tool/downloader.rb: ditto + * tool/eval.rb: ditto + * tool/expand-config.rb: ditto + * tool/extlibs.rb: ditto + * tool/fake.rb: ditto + * tool/file2lastrev.rb: ditto + * tool/gem-unpack.rb: ditto + * tool/gen_dummy_probes.rb: ditto + * tool/gen_ruby_tapset.rb: ditto + * tool/generic_erb.rb: ditto + * tool/id2token.rb: ditto + * tool/ifchange: ditto + * tool/insns2vm.rb: ditto + * tool/instruction.rb: ditto + * tool/jisx0208.rb: ditto + * tool/merger.rb: ditto + * tool/mkrunnable.rb: ditto + * tool/node_name.rb: ditto + * tool/parse.rb: ditto + * tool/rbinstall.rb: ditto + * tool/rbuninstall.rb: ditto + * tool/rmdirs: ditto + * tool/runruby.rb: ditto + * tool/strip-rdoc.rb: ditto + * tool/vcs.rb: ditto + * tool/vtlh.rb: ditto + * tool/ytab.sed: ditto + * tool/enc-unicode.rb: fix typo + * tool/mk_call_iseq_optimized.rb: ditto + * tool/update-deps: ditto + [ruby-core:76215] [Bug #12539] + by Noah Gibbs <the.codefolio.guy@g...> + Sat Jul 2 18:04:24 2016 NARUSE, Yui <naruse@r...> * lib/uri/mailto.rb (initialize): RFC3986_Parser#split sets opaque -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/