[MDSAL-62] Rename Opendaylight specific YANG modules to format odl-{$module} Created: 13/Nov/14  Updated: 19/Aug/19

Status: Confirmed
Project: mdsal
Component/s: models
Affects Version/s: None
Fix Version/s: None

Type: Improvement
Reporter: Tony Tkacik Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All

Issue Links:
Blocks
blocks MDSAL-55 Topic: Continuos: Decrease technical ... Resolved

 Description   

Config subsystem modules should follow naming convention:

odl-{$module}-cfg for configuration of components

Opendaylight specific MD-SAL related models should follow conventions:

odl-{$module}

 Comments   
Comment by Carol Sanders [ 04/May/15 ]

This bug is part of the project to Move all ADSAL associated component bugs to ADSAL

Comment by Ankit agarwal [ 11/May/15 ]

Hi carol,
I am thinking of working on this bug.

can you please tell me know if i can work on this bug individually and

if yes, I suppose making naming changes in POM of these config modules will be enough.
Is that what, this bug is intend to descibe?

Comment by Tony Tkacik [ 11/May/15 ]

Hi Ankit,
this bug is far-reaching that seems obvious - renaming YANG models
may result in API and cross-project change which is not obvious at first sight:

  • models are imported by name
  • RESTCONF URIs uses model name
  • some of Java generated APIs uses model name as base for their name
Comment by Vratko Polak [ 18/Oct/16 ]

> odl-{$module}-cfg

I would recommend $module to be decomposed as $project-$functionality
to give each project a freedom to name their functionalities freely, without risking name conflicts with other projects.

Simplified example: odl-bgpcep-bgp for a mdsal module, odl-bgpcep-bgp-cfg for corresponding config subsystem module.
(Of course bgpcep already has several BGP-related modules.)

Note that ideally this should also apply to fundamental ODL modules, for example not "config", but "odl-controller-config".

Generated at Wed Feb 07 20:08:33 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.