X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2FObject.html;fp=doc%2Ffiles%2Finstall_rb.html;h=b75708fbe6ce940da42f312ffdc8cdb4ba71fa56;hb=7c9314f502cde8daad23b61d10b24a542e04154a;hp=4dc88754ceb421327b0e44114144cc241a94bd42;hpb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/files/install_rb.html b/doc/Object.html similarity index 59% rename from doc/files/install_rb.html rename to doc/Object.html index 4dc8875..b75708f 100644 --- a/doc/files/install_rb.html +++ b/doc/Object.html @@ -1,195 +1,417 @@ - - - + + - File: install.rb - - - - - - - - - - -
-

install.rb

- - - - - - - - - -
Path:install.rb -
Last Update:Fri Nov 08 12:57:19 +0000 2013
-
- - -
- - - -
- - -
-

Required files

- -
- rbconfig   - find   - fileutils   - tempfile   - optparse   - ostruct   - rdoc/rdoc   -
-
- -
- -
-

Methods

- -
- build_rdoc   - check_prereqs   - do_bins   - do_configs   - do_libs   - glob   - install_binfile   - prepare_installation   -
-
+ -
+ Class: Object + - -
-

Included Modules

+ + + + -
- FileUtils -
-
- -
- - -
-

Constants

- -
- - - - - - - - - - - -
PREREQS=%w{rubygems stomp}
InstallOptions=OpenStruct.new
-
-
- - - - - - - -
-

Public Instance methods

- -
- - - - -
-

+ + + +

+
+
+

In Files

+
+
    + +
+
+
+ + +
+ +
+ + + +
+

Parent

+ + + +
+ + + + + + + + + + + + +
+ +
+ + + + + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + +
+ + +
+
+ +
+

Object

+ +
+ +
+ + + + + + + + + +
+

Public Instance Methods

+ + +
+ + +
+ + build_rdoc(files) + click to toggle source + +
+ +
+ +

Build the rdoc documentation.

-

[Source]

-
+ + + +
-     # File install.rb, line 246
-246: def build_rdoc(files)
-247:   return unless $haverdoc
-248:   begin
-249:     r = RDoc::RDoc.new
-250:     r.document(["--main", "MCollective", "--line-numbers"] + files)
-251:   rescue RDoc::RDocError => e
-252:     $stderr.puts e.message
-253:   rescue Exception => e
-254:     $stderr.puts "Couldn't build RDoc documentation\n#{e.message}"
-255:   end
-256: end
-
-
-
-
- -
- - - - -
-

[Source]

-
+ # File install.rb, line 248 +248: def build_rdoc(files) +249: return unless $haverdoc +250: begin +251: r = RDoc::RDoc.new +252: r.document(["--main", "MCollective", "--line-numbers"] + files) +253: rescue RDoc::RDocError => e +254: $stderr.puts e.message +255: rescue Exception => e +256: $stderr.puts "Couldn't build RDoc documentation\n#{e.message}" +257: end +258: end +
+ +
+ + +
+ + +
+ + +
+ + check_prereqs() + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
     # File install.rb, line 65
 65: def check_prereqs
@@ -201,25 +423,34 @@ Build the rdoc documentation.
 71:       exit(-1)
 72:     end
 73:   end
-74: end
-
-
-
-
- -
- - - - -
-

[Source]

-
+74: end +
+ +
+ + +
+ + +
+ + +
+ + do_bins(bins, target, strip = 's?bin/') + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
     # File install.rb, line 86
 86: def do_bins(bins, target, strip = 's?bin/')
@@ -228,25 +459,34 @@ Build the rdoc documentation.
 89:     obf = bf.gsub(/#{strip}/, '')
 90:     install_binfile(bf, obf, target)
 91:   end
-92: end
-
-
-
-
- -
- - - - -
-

[Source]

-
+92: end +
+ +
+ + +
+ + +
+ + +
+ + do_configs(configs, target, strip = 'etc/') + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
     # File install.rb, line 76
 76: def do_configs(configs, target, strip = 'etc/')
@@ -257,25 +497,34 @@ Build the rdoc documentation.
 81:     makedirs(oc, {:mode => 0755, :verbose => true})
 82:     install(cf, ocf, {:mode => 0644, :preserve => true, :verbose => true})
 83:   end
-84: end
-
-
-
-
- -
- - - - -
-

[Source]

-
+84: end +
+ +
+ + +
+ + +
+ + +
+ + do_libs(libs, target, strip = 'lib/') + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
      # File install.rb, line 94
  94: def do_libs(libs, target, strip = 'lib/')
@@ -289,25 +538,34 @@ Build the rdoc documentation.
 102:       install(lf, olf, {:mode => 0644, :preserve => true, :verbose => true})
 103:     end
 104:   end
-105: end
-
-
-
-
- -
- - - - -
-

[Source]

-
+105: end +
+ +
+ + +
+ + +
+ + +
+ + glob(list) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
     # File install.rb, line 57
 57: def glob(list)
@@ -316,74 +574,90 @@ Build the rdoc documentation.
 60:   g.compact!
 61:   g.uniq!
 62:   g
-63: end
-
-
-
-
- -
- - - - -
-

+63: end +

+ +
+ + +
+ + +
+ + +
+ + install_binfile(from, op_file, target) + click to toggle source + +
+ +
+ +

Install file(s) from ./bin to RbConfig::CONFIG[‘bindir’]. Patch it on the way to insert a #! line; on a Unix install, the command is named as expected

-

[Source]

-
+ + + +
-     # File install.rb, line 261
-261: def install_binfile(from, op_file, target)
-262:   tmp_file = Tempfile.new('mcollective-binfile')
-263: 
-264:   if InstallOptions.ruby
-265:     ruby = InstallOptions.ruby
-266:   else
-267:     ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-268:   end
-269: 
-270:   File.open(from) do |ip|
-271:     File.open(tmp_file.path, "w") do |op|
-272:       op.puts "#!#{ruby}"
-273:       contents = ip.readlines
-274:       contents.shift if contents[0] =~ /^#!/
-275:       op.write contents.join
-276:     end
-277:   end
-278: 
-279:   install(tmp_file.path, File.join(target, op_file), :mode => 0755, :preserve => true, :verbose => true)
-280:   tmp_file.unlink
-281: end
-
-
-
-
- -
- - - - -
-

+ # File install.rb, line 263 +263: def install_binfile(from, op_file, target) +264: tmp_file = Tempfile.new('mcollective-binfile') +265: +266: if InstallOptions.ruby +267: ruby = InstallOptions.ruby +268: else +269: ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name']) +270: end +271: +272: File.open(from) do |ip| +273: File.open(tmp_file.path, "w") do |op| +274: op.puts "#!#{ruby}" +275: contents = ip.readlines +276: contents.shift if contents[0] =~ /^#!/ +277: op.write contents.join +278: end +279: end +280: +281: install(tmp_file.path, File.join(target, op_file), :mode => 0755, :preserve => true, :verbose => true) +282: tmp_file.unlink +283: end +

+ +
+ + +
+ + +
+ + +
+ + prepare_installation() + click to toggle source + +
+ +
+ +

Prepare the file installation.

-

[Source]

-
+ + + +
      # File install.rb, line 110
 110: def prepare_installation
@@ -502,37 +776,50 @@ Prepare the file installation.
 223:     destdir = ''
 224:   end
 225: 
-226:   configdir = File.join(destdir, configdir)
-227:   bindir = File.join(destdir, bindir)
-228:   sitelibdir = File.join(destdir, sitelibdir)
-229: 
-230:   makedirs(configdir) if InstallOptions.configs
-231:   makedirs(bindir)
-232:   makedirs(sbindir)
-233:   makedirs(sitelibdir)
-234:   makedirs(plugindir)
-235: 
-236:   InstallOptions.sitelibdir = sitelibdir
-237:   InstallOptions.configdir = configdir
-238:   InstallOptions.bindir  = bindir
-239:   InstallOptions.sbindir  = sbindir
-240:   InstallOptions.plugindir  = plugindir
-241: end
-
-
-
-
- - -
- - -
- - - +226: configdir = File.join(destdir, configdir) +227: bindir = File.join(destdir, bindir) +228: sbindir = File.join(destdir, sbindir) +229: sitelibdir = File.join(destdir, sitelibdir) +230: plugindir = File.join(destdir, plugindir) +231: +232: makedirs(configdir) if InstallOptions.configs +233: makedirs(bindir) +234: makedirs(sbindir) +235: makedirs(sitelibdir) +236: makedirs(plugindir) +237: +238: InstallOptions.sitelibdir = sitelibdir +239: InstallOptions.configdir = configdir +240: InstallOptions.bindir = bindir +241: InstallOptions.sbindir = sbindir +242: InstallOptions.plugindir = plugindir +243: end +
+ +
+ + +
+ + +
+ + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ +
+

[Validate]

+

Generated with the Darkfish + Rdoc Generator 1.1.6.

+
- \ No newline at end of file + +