[
https://issues.apache.org/jira/browse/MSITE-569?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14563627#comment-14563627
]
Gordon Pettey commented on MSITE-569:
-------------------------------------
Not to re-open this, but there *is* a use case. I have a parent pom with over a
dozen modules. I'd like that modules menu to be inheritable by the child
projects as is (possibly as some other ref id), so navigation directly between
siblings would be possible.
However, since the attribute doesn't actually work as described, it is rather
useless.
> Deprecate inheritAsRef
> ----------------------
>
> Key: MSITE-569
> URL: https://issues.apache.org/jira/browse/MSITE-569
> Project: Maven Site Plugin
> Issue Type: Bug
> Components: inheritance, site descriptor
> Affects Versions: 2.2, 3.0-beta-3
> Reporter: Lukas Theussl
>
> The [decorationModel
> docs|http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html#class_menu]
> say about the inheritAsRef parameter:
> {noformat}
> If this is a reference, setting true means that it will be populated in the
> project,
> whereas if it is false, it is populated in the parent and then inherited.
> Default value is: false.
> {noformat}
> This is apparently a documentation bug as leaving away the inheritAsRef
> parameter the refs get populated in the (inheriting) child project. Eg the
> maven [parent
> pom|https://svn.apache.org/repos/asf/maven/pom/trunk/maven/src/site/site.xml]
> defines a <menu ref="reports" inherit="bottom" /> element (ie
> inheritAsRef=false), but the intent (and actual effect) is that this menu
> contains the reports of the inheriting projects, and not those of the maven
> parent pom.
> However, specifying inheritAsRef=true does not work as expected. There is an
> [IT|https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/it/inheritedMenus/]
> that compares the difference, one can see that the menus do not get
> populated in the parent project.
> Above all, I don't quite see the use of this parameter, why would one want
> the parent's parent/modules/reports in the child project? Brett mentioned
> somewhere that the original intent was to enable a permanent link to a
> top-level parent project. This can simply be achieved with a normal menu that
> gets inherited.
> So given all that, that there is no use case, that it's wrongly documented
> and that it doesn't work, I propose to deprecate the feature.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
