https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/MDSAL-301 mdsal <p>This is a top-level tracker issue, which will need to be addressed in mdsal-binding-generator-impl and in mdsal-binding2-generator-impl.</p> <p>The code here is twisted and inefficient, causing huge memory usage for strings during code generation, especially with large models.</p> <p>Two things need to happen:</p> <ul> <li>YANG snippet needs to be generated and filtered as a CharSource, e.g. lazily, without instantiating the full thing before the class is actually output</li> <li>Snippet generation needs to work on top of org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement view of the world, so that 'uses' are not expanded, but rather the snippet quotes the actual YANG text</li> </ul> <p> </p> MDSAL-301

Rework javadoc generation in bindings

Epic Medium Resolved Done Robert Varga Robert Varga Thu, 25 Jan 2018 15:43:16 +0000 Tue, 27 Mar 2018 01:37:18 +0000 Tue, 27 Mar 2018 01:37:18 +0000 Oxygen SR1 Binding codegen Binding V2 codegen 0 2 <p>Actually CharSource is rather inefficient and needlessly complex. The class exposing a YANG text snippet is coming in yang-model-export-2.0.2 and it has the shape of Iterable&lt;String&gt;, which is perfectly fine. It will need to be integrated once we adopt yangtools-2.0.2.</p> <p>binding v1 use of YangTextSnippet: <a href="https://git.opendaylight.org/gerrit/68031" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/68031</a></p> <p>binding v2 use of YangTextSnippet: <a href="https://git.opendaylight.org/gerrit/68032" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/68032</a></p> <p> </p> <p>As it turns out, these two patches end up slimming our runtime support jars by ~260kB.</p> <p>Picking this up once again, this actually is a fault at how <a href="https://jira.opendaylight.org/browse/YANGTOOLS-193" title="Add snippet of yang file into comments of generated classes" class="issue-link" data-issue-key="YANGTOOLS-193"><del>YANGTOOLS-193</del></a> was implemented. It confused DocumentedType.getDescription() and GeneratedType.getComment() – the two have differing semantics and getComment() is actually unused. It is the latter method which should encapsulate enough data to reconstruct the javadoc.</p> <p><a href="https://git.opendaylight.org/gerrit/68191" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/68191</a> moved the template code, creating an abstract layer to make the old structure work – this needs to be followed-up with cleaning up the API and eliminating the unneeded layer.</p> <p><a href="https://git.opendaylight.org/gerrit/68254" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/68254</a> cleans the entire mess up, so that we properly capture state and push it towards the templates.</p> <p><a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=JieHan2017" class="user-hover" rel="JieHan2017">JieHan2017</a> can you port last two patches to binding V2, please?</p> <p>Yes, I will.</p> <p>Ported to binding v2 master: <br/> <a href="https://git.opendaylight.org/gerrit/68657" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/68657</a></p> Development Epic Color ghx-label-1 Epic Name YANG javadoc snippet optimization Epic Status Rank 0|i039s7: