lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Uwe Schindler (JIRA)" <>
Subject [jira] [Commented] (SOLR-10728) fix/improve rat-sources and check-forbidden-api in solr-ref-guide
Date Tue, 23 May 2017 07:23:04 GMT


Uwe Schindler commented on SOLR-10728:

Hi Hoss,

Sorry I was a bit unclear yesterday. It was late!

In general, if you look at other modules in Lucene/Solr, you will see that they have a layout,
that formed like Maven builds (not completely, because we do not have src/main/ up to now).
You have a sub directory below src, "main (or java, we need to change this to main/java at
some point), test, tools". I suggest to use the same layout for the ref guide: src/docs (or
src/main) and src/tools/java. When you have main, test and tools you have 3 types of source

As example see the analysis/common package. It actually has a main java folder, the tests
and then a tools folder below src. The test folder is additionally split between java and
groovy, because we have both types of tools.

I can look into this!

Indeed, we can keep the current layout, because the properties explained above can be customized!
So see this as a suggestion to make it more consistent, especially with Maven/Gradle world.
If we change at some point away from Ant, we would make life easier.

> fix/improve rat-sources and check-forbidden-api in solr-ref-guide
> -----------------------------------------------------------------
>                 Key: SOLR-10728
>                 URL:
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Hoss Man
>            Assignee: Uwe Schindler
> via email from uwe...
> {noformat}
> We have already a check for licenses by default enabled in all sub directories of the
build. It's called "rat-sources"
> The problem with the rat-sources ant target is, that although it runs on the ref-guide
subdirectory, it does not catch
> violations for several reasons:
> 1. it does not yet look into all file types
> 2. for some files, e.g. the java code, you are using a non-standard subdirectory of the
project folder. To fix this, there are
> two options: a) move to src/.../java or tools like in other modules (by that they are
also compiled automatically without extra
> compilation tasks in build.xml) or b) add the additional directories  to some special
ANT property _before_ loading
> common-build.xml:
>   <!-- These patterns can be defined to add additional files for checks, relative
to module's home dir -->
>   <property name="rat.additional-includes" value=""/>
>   <property name="rat.additional-excludes" value=""/>
> In the local build, you can configure the license checker by adding those lines fillesd
out *before* including
> common-build.xml. If you open an issue, I can maybe take care of that this week (I am
a bit busy). I'd also like to clean up
> the build directory, because it has some code duplication automatically handled by common-build.xml.
In addition other checks
> are missing, too - because the non-standard folder names (e.g. forbidden-apis).
> {noformat}

This message was sent by Atlassian JIRA

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message