Project

General

Profile

Actions
Copy link

Feature #4853

closed

Rewrite syntax specifications using IETF ABNF

Added by Junxiao Shi about 5 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Junxiao Shi
Start date:
Due date:
% Done:

100%

Estimated time:
4.50 h

Description

NDN Packet Format spec, along with several other specs, uses a variant of Backus-Naur form to specify its syntaxes. However, it's unclear exactly which variant is followed. This can lead to ambiguity and hinder protocol standardization.
This issue is to choose a BNF variant and rewrite projections accordingly.
Future protocol revisions should be checked against this variant.

Actions
Copy link
 #1

Updated by Junxiao Shi about 5 years ago

It appears that the existing specs are using W3C’s EBNF variant, as defined in https://www.w3.org/TR/REC-xml/#sec-notation

Actions
Copy link
 #2

Updated by Junxiao Shi about 5 years ago

  • Status changed from New to Resolved
  • Assignee set to Junxiao Shi
  • Start date deleted (02/24/2019)
  • % Done changed from 0 to 60
Actions
Copy link
 #3

Updated by Davide Pesavento about 5 years ago

Junxiao Shi wrote:

It appears that the existing specs are using W3C’s EBNF variant, as defined in https://www.w3.org/TR/REC-xml/#sec-notation

That doesn't seem to support the "number of repetitions" syntax as used in nonNegativeInteger specification, e.g. BYTE{2}.

Actions
Copy link
 #4

Updated by Junxiao Shi about 5 years ago

If everyone agrees, I can rewrite the whole spec with IETF's ABNF as defined in RFC5234.

Actions
Copy link
 #5

Updated by Junxiao Shi about 5 years ago

As discussed on 20190227 call, I'm to provide a preview of how the documents look like in IETF ABNF. It's now in Change 5280 patchset2. I only updated name.rst data.rst. Other files will be updated after these are reviewed.

Actions
Copy link
 #6

Updated by Junxiao Shi about 5 years ago

  • Subject changed from Clarify BNF variant to Rewrite syntax specifications using IETF ABNF
  • Description updated (diff)
  • % Done changed from 60 to 100
  • Estimated time set to 4.50 h
Actions
Copy link
 #7

Updated by Davide Pesavento almost 5 years ago

  • Status changed from Resolved to Code review
Actions
Copy link
 #8

Updated by Junxiao Shi almost 5 years ago

  • Status changed from Code review to Closed
Actions
Copy link
 #9

Updated by Davide Pesavento almost 5 years ago

What about the syntax specifications in NDNLPv2? Can you convert those too?

Actions
Copy link
 #10

Updated by Junxiao Shi almost 5 years ago

What about the syntax specifications in NDNLPv2?

This belongs to #4927.

Actions
Copy link
 #11

Updated by Davide Pesavento over 4 years ago

The naming conventions TR also needs an update.

Actions
Copy link

Also available in: Atom PDF