[jira] [Commented] (SOLR-10728) fix/improve rat-sources and check-forbidden-api in solr-ref-guide

["Hoss Man (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-10728?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16020222#comment-16020222 ] 

Hoss Man commented on SOLR-10728:
---------------------------------


One note: the primary reason behind the current directory structure under {{solr/solr-ref-guide}} was to ensure that the "tools" didn't get lumped in with the actually "src" of the ref-guide.  but i gather from uwe's comments that having these tools outside of the "src" directory is problematic because of other assumptions in the common build files.

so i'm not really clear on what the best pathforward is ... IIUC Uwe's saying we can add "rat.additional-includes" to get RAT to find the files in their current paths, but that he wants to move/refactor some of the build stuff (in some way i'm not 100% clear on) anyway because of how forbidden-apis work ... so in the absence of more specific instructions i'm going to leave this alone until Uwe has a chance to look at it.

> fix/improve rat-sources and check-forbidden-api in solr-ref-guide
> -----------------------------------------------------------------
>
>                 Key: SOLR-10728
>                 URL: https://issues.apache.org/jira/browse/SOLR-10728
>             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
(v6.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org