Corrected various bugs that caused the build to break
[java-idp.git] / custom / README.txt
index 12a13f6..cf2e6d6 100644 (file)
@@ -24,8 +24,8 @@ the following directories
     your-extension-directory/
        etc/ - [Optional] This directory contains anything that isn't java source but still needs 
               to be on the classpath.  This can include subdirectories, and can be excluded.
-       lib/ - [Optional] any third party jars your extension needs
-       src/ - [REQUIRED] your extension's source
+       lib/ - [REQUIRED if 'src' is present] any third party jars your extension needs
+       src/ - [Optional] your extension's source
        tests/ - [Optional] Your extension's JUnit test case source.
        web/ - [Optional] Any web pages, images, JSPs, etc. that should be included with the war
        build.properties - [REQUIRED] build properties for your extension 
@@ -55,4 +55,10 @@ III. Compile and deploy Shibboleth as normal.
 3. Cautionary Note
 DO NOT include libraries, with your extension, that are included with the Shibboleth
 IdP or SP.  If you do, and there are version mismatches between the two jars, you will get 
-unexpected exceptions during runtime as class versions conflict.
\ No newline at end of file
+unexpected exceptions during runtime as class versions conflict.
+
+4. Common Errors
+4.1 /path/to/extension/lib not found
+  This error occurs because Ant is unable to ignore references to directories of jars that don't
+  exist.  Simply create a 'lib' directory in your extension directory structure, you do not have 
+  to place anything in it.
\ No newline at end of file