jruby-startup 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7eb93d24d3b90eb28f1ada58393a3b5dcac9f5d69253a287b1abcf6241985ce
-  data.tar.gz: 02cfb170c0583e26eaf5a121adca19a42cc6bc92279f7ebe3befe6db83ad88f1
+  metadata.gz: 5d586ea3e5aaf44474a4360c6fe525da30cef4c6e8983fd4041ec3cedf28879b
+  data.tar.gz: 9f68dc24a9b1ee72ed20242a69f7523ae9aa5c0d9e311e32d9cf87a4c13db29d
 SHA512:
-  metadata.gz: a59b8bec8a5c0e7f68b0b47ef31af83474155a7831fa5fb5e2803763621e079ccf76b8817a6de7e5adad6afdfc12dd1ff31e67ba8b319ca17657dffbad4e7297
-  data.tar.gz: ca41a4d37fc5e3a6c643ae0c97cc32db4075aeaa153eb703d9144035ee36a06724d409d7b4957f5e941f91e9d48c4c87bae8fe307219c8cb69e7b02011807d14
+  metadata.gz: 0c737f3446f4a62b90e8bc8db79e90d07859bd0f5e7a3dbb5545c6eddf6b718a0e41348f7641c5e1e0df069e75e56468576e96027ad63c6831c22af63ed8dad0
+  data.tar.gz: '030659741bf3725679bfde76c9599159b8301eece558c617458664a3e51bf79bae49d826b3f54104c556d01b46a1e2ca6ff0104ae8b5f964bee94d2e4b32248f'

data/README.md

@@ -1,35 +1,39 @@
-# Jruby::Startup
+# JRuby::Startup
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jruby/startup`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a collection of utilities to help improve the startup time of
+JRuby-based applications.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'jruby-startup'
-```
-
-And then execute:
+`gem install jruby-startup`
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+The utilities provided by this gem are described below.
 
-    $ gem install jruby-startup
+### generate-appcds
 
-## Usage
+The `generate-appcds` command is used to generate an AppCDS, or
+"Application-specific Class Data Store" archive on OpenJDK 11 or
+higher. This archive pre-processes the classes in JRuby to eliminate
+some overhead at startup.
 
-TODO: Write usage instructions here
+By using this utility and setting some environment variables, many
+JRuby commands can be sped up a fair amount.
 
-## Development
+Running `generate-appcds` alone will generate the AppCDS archive based
+on a command line of `-e 1` as passed to JRuby. You can provide a
+different command line, in quotes, to the `generate-appcds` command.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+$ generate-appcds
+*** Outputting list of classes at /Users/headius/projects/jruby/lib/jruby.list
+...
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+When the command has completed, you will see some environment variables
+to set that will enable the use of the AppCDS archive.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/headius/jruby-startup.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jruby/jruby-startup.

data/lib/jruby/startup/appcds.rb

@@ -7,6 +7,10 @@ module JRuby::Startup::AppCDS
       puts "*** Warning: this feature is only supported on Java 11 or higher"
     end
 
+    if JRUBY_VERSION < '9.2.1.0'
+      puts "*** JRuby 9.2.1 or higher recommended"
+    end
+
     # Go for it
     command_line = argv[0] || "-e 1"
     jruby_home = ENV_JAVA['jruby.home']
@@ -27,7 +31,7 @@ module JRuby::Startup::AppCDS
     # Use class list to generate AppCDS archive
     puts "*** Generating shared AppCDS archive at #{jruby_jsa}"
 
-    fail unless system "VERIFY_JRUBY=1 JAVA_OPTS='-Xshare:dump -XX:+UnlockDiagnosticVMOptions -XX:SharedClassListFile=#{jruby_list} -XX:SharedArchiveFile=#{jruby_jsa}' #{jruby_exe} #{command_line}"
+    fail unless system "VERIFY_JRUBY=1 JAVA_OPTS='-Xshare:dump -XX:G1HeapRegionSize=2m -XX:+UnlockDiagnosticVMOptions -XX:SharedClassListFile=#{jruby_list} -XX:SharedArchiveFile=#{jruby_jsa}' #{jruby_exe} #{command_line}"
 
     # Display env vars to use for the new archive
     puts <<~END
@@ -35,8 +39,8 @@ module JRuby::Startup::AppCDS
 
     Set the following environment variables to use the shared archive:
 
-    VERIFY_JRUBY=1
-    JAVA_OPTS="-XX:-VerifySharedSpaces -XX:SharedArchiveFile=#{jruby_jsa}"
+    VERIFY_JRUBY=1 # Only for JRuby versions 9.2.0.0 or earlier
+    JAVA_OPTS="-XX:G1HeapRegionSize=2m -XX:SharedArchiveFile=#{jruby_jsa}"
     END
   end
 end

data/lib/jruby/startup/version.rb

@@ -1,5 +1,5 @@
 module JRuby
   module Startup
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jruby-startup
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Charles Oliver Nutter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement