[
https://issues.apache.org/jira/browse/SOLR-10728?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16021499#comment-16021499
]
Hoss Man commented on SOLR-10728:
---------------------------------
bq. 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 files.
Ok ... gotcha ... {{src/docs}} is the part i wasn't clear on before ... you
mentioned setting it up to match other modules, and having a {{src/.../java}}
but the ref-guide is different then every other module becuase there is no
"main source java" -- just the tools. so i was trying to figure out where you
wanted to shoehorn the {{\*.adoc}} files into the {{src/(java|test|tools)}}
convention we use everywhere else ... adding "src/docs" clears that up
FWIW: I experimented locally with this (moving everything in {{src}} to
{{src/docs}} and {{tools}} to {{src/tools}}) and making the minor tweaks needed
to the build.xml to get the html & pdf builds to work, but that still didn't
make {{ant check-forbidden-apis}} happy because there's still no {{src/java}}
... which is the same error as before i tried re-orging files (hence my
confusion and vague concern that maybe you ment we should put the {{\*.adoc}}
files in {{src/java}} to "fix" this) ... so i abandoned that.
bq. I can look into this!
That would be awesome, because i just keep confusing myself as i try to unravel
the build targets ... if/when you get a chance to take a look at it, feel free
to ping me if you have any questions/concerns about where/how/why any of the
solr-ref-guide specific build targets/tools work.
> 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: [email protected]
For additional commands, e-mail: [email protected]
