Document: draft-ietf-netmod-yang-module-filename
Title: YANG module file name convention
Reviewer: Aihua Guo
Review result: Has Issues

Hi,

I have been selected as the Operational Directorate (opsdir) reviewer for this
Internet-Draft.

The Operational Directorate reviews all operational and management-related
Internet-Drafts to ensure alignment with operational best practices and that
adequate operational considerations are covered.

A complete set of _"Guidelines for Considering Operations and Management in
IETF Specifications"_ can be found at
https://datatracker.ietf.org/doc/draft-ietf-opsawg-rfc5706bis/.

While these comments are primarily for the Operations and Management Area
Directors (Ops ADs), the authors should consider them alongside other feedback
received.

- Document: draft-ietf-netmod-yang-module-filename

- Reviewer: Aihua Guo

- Review Date: 02-24-2026

- Intended Status: Standards Track

---

## Summary

- Has Issues: This document contains logical inconsistency that should be fixed
prior to publication.

## Major Issues

None.

---

## Minor Issues

As other reviewers already pointed out, Section 2 presents logically
contradicting statements regarding the required format of the module file name
when the YANG module has associated sematic version.

These two (repetitive) statements indicate that a file name with YANG sematic
version is optional, and file with revision date is still acceptable: "If a
revision has an associated YANG semantic version (ysv:version)
   then it MAY use the YANG semantic version instead of the revision
   date in the file name of a YANG file"
and,
"YANG module (or submodule) files MAY be identified using either
   revision-date or YANG semantic version (ysv:version)"

While the following statement says the opposite:
"If the YANG module (or submodule) has an associated YANG semantic
   version (ysv:version), then a file name that use the YANG semantic
   version MUST be used.  In addition, a file with the revision date in
   the file name MAY be created as well."

The document needs to clarify and fix the intended behavior. The document is in
good shape otherwise.

---

## Nits

In Section 1, Introduction

For precision & consistency:
OLD
"This document defines the YANG module file convention"

NEW
"This document defines the YANG module file name convention"

---


_______________________________________________
netmod mailing list -- [email protected]
To unsubscribe send an email to [email protected]

Reply via email to