From 6d605b44ccc721055433ba34721e592af152df09 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 10 Nov 2010 12:19:39 -0800 Subject: [PATCH] Update readme instructions with `git clone --recursive` --- readme.txt | 43 ++++++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 17 deletions(-) diff --git a/readme.txt b/readme.txt index 8e01aaee1a..0b0df0c962 100644 --- a/readme.txt +++ b/readme.txt @@ -1,9 +1,13 @@ ============================== Spring Integration ============================= To check out the project and build from source, do the following: - git clone git://git.springsource.org/spring-integration/spring-integration.git - cd spring-integration - ./gradlew build + git clone --recursive git://git.springsource.org/spring-integration/spring-integration.git +cd spring-integration +./gradlew build + +Note: the --recursive switch above is important, as spring-integration uses +git submodules, which must themselves be cloned and initialized. If --recursive +is omitted, doing so becomes a multi-step process. ------------------------------------------------------------------------------- To generate Eclipse metadata (.classpath and .project files), do the following: @@ -32,18 +36,23 @@ The result will be available in 'docs/build/api'. ###### OSGI Notes ###### 1. Dependency on Third Party Bundles - Some adapters depend on third party libraries (bundles). - Spring hosts Enterprise Bundle Repository (EBR) https://ebr.springsource.com/repository/app/ - where you can download many third party JARs as valid OSGi bundles. - If a particular bundle is not available in Spring's EBR, there are tools that can convert regular - JAR to a bundle JAR. One of them is Bundlor http://www.springsource.org/bundlor which can auto-generate - MANIFEST as part of standard project lifecycle or simply convert non-bundle JAR to a bundle JAR. + Some adapters depend on third party libraries (bundles). + Spring hosts the Enterprise Bundle Repository (EBR) at + https://ebr.springsource.com/repository/app/, where you can download + many third-party JARs as valid OSGi bundles. + If a particular bundle is not available in Spring's EBR, there are tools + that can convert regular JAR to a bundle JAR. One of them is Bundlor + http://www.springsource.org/bundlor which can auto-generate an OSGi + MANIFEST.MF as part of standard project lifecycle or simply convert a + non-bundle JAR to a bundle JAR. 2. Boot delegation - Some adapters depend on extension packages that are available to the boot class loader. - For example; Feed Adapter depends on com.sun.syndication.feed. Since by default OSGi only - loads java.* from the boot class loader, other packages that must be loaded from the boot class loader - can therefore be specified with the 'org.osgi.framework.bootdelegation' System property. - For example: - org.osgi.framework.bootdelegation=com.sun.*,org.w3c.*. . . . - -=============================================================================== \ No newline at end of file + Some adapters depend on extension packages that are available to the boot + class loader. As a case in point, the Feed Adapter depends on + com.sun.syndication.feed. Since by default OSGi only loads java.* from the + boot class loader, other packages that must be loaded from the boot class + loader can therefore be specified with the + 'org.osgi.framework.bootdelegation' System property. + For example: + org.osgi.framework.bootdelegation=com.sun.*,org.w3c.*. . . . + +===============================================================================