Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

BUILDING.md: Added info about incremental compiling, cleaning after switching branches #1475

Merged
merged 1 commit into from

3 participants

@DavidEGrayson

When I started developing with JRuby I didn't know how to do a quick incremental compilation. I ran "mvn package" after every change to any Java code. Thankfully, @mkristian told me how to do it in this comment:

#1470 (comment)

@mkristian also said it would be necessary to clean the build after switching branches (i.e. from master to jruby-1_7) and I have confirmed that it is necessary with an experiment, as discussed in issue #1470.

I think it would be helpful to other new JRuby developers if this information was in BUILDING.md, so I made this pull request to add it. I really don't know much about Maven or Java compilation but hopefully I got this right.

This pull request goes to the jruby-1_7 branch, which I think is the right way to do it. It should be merged into master too so people can see it easily on github. Thanks!

@DavidEGrayson DavidEGrayson BUILDING.md: Added a new section about incremental compiling and a se…
…ntence about cleaning after switching branches.

This information is derived from a comment by mkristian:
jruby#1470 (comment)
bf27fcb
@mkristian mkristian merged commit 05a15dc into jruby:jruby-1_7

1 check failed

Details default The Travis CI build failed
@mkristian
Owner

merged to master as well - thanx

@enebo enebo added this to the JRuby 1.7.11 milestone
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Feb 2, 2014
  1. @DavidEGrayson

    BUILDING.md: Added a new section about incremental compiling and a se…

    DavidEGrayson authored
    …ntence about cleaning after switching branches.
    
    This information is derived from a comment by mkristian:
    jruby#1470 (comment)
This page is out of date. Refresh to see the latest.
Showing with 12 additions and 0 deletions.
  1. +12 −0 BUILDING.md
View
12 BUILDING.md
@@ -93,6 +93,14 @@ mvn -Pbootstrap
This only needs to be run once to install these gems or if you update
one of the gems to a newer version or clean out all installed gems.
+### Incremental compiling
+
+After changing Java code, you can recompile quickly by running:
+
+```
+mvn compile
+```
+
### Day to Day Testing
For normal day-to-day testing, we recommend running the Ruby 1.9 tests
@@ -142,6 +150,10 @@ mvn clean install -Pjruby-jars
this first cleans everything and then starts the new build in one go !
+Cleaning the build may be necessary after switching to a different
+version of JRuby (for example, after switching git branches) to ensure
+that everything is rebuilt properly.
+
NOTE: ```mvn clean``` just cleans the **jruby-core** artifact and the **./lib/jruby.jar** !
Distribution Packages
Something went wrong with that request. Please try again.