Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#4117 closed defect (fixed)

Flipped descriptions of ncr_protocol and ncr_format in Kea Administrator Manual

Reported by: shane Owned by: tmark
Priority: medium Milestone: Kea1.0-beta
Component: documentation Version: git
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: Low
Sub-Project: DHCP Feature Depending on Ticket:
Estimated Difficulty: 0.25 Add Hours to Ticket: 0
Total Hours: 1 Internal?: no

Description (last modified by sar)

This is a very minor issue, and unlikely to confuse anyone. Probably it should be fixed though.

The description of ncr_protocol and ncr_format are flipped in the Kea Administrator Manual:

  • ncr_protocol - Packet format to use when sending requests to D2. Currently only JSON format is supported. Other formats may be available in future releases.
  • ncr_format - Socket protocol to use when sending requests to D2. Currently only UDP is supported. TCP may be available in an upcoming release.

http://git.kea.isc.org/~tester/kea/guide/kea-guide.html#d2-server-parameter-config

Subtickets

Change History (6)

comment:1 Changed 4 years ago by tmark

  • Milestone changed from Kea-proposed to Kea1.0
  • Owner set to tmark
  • Status changed from new to assigned

comment:2 Changed 4 years ago by tmark

Descriptions of the two parameters, ncr-protocol and ncr-format
were swapped in three places (but hey, we were consistent!):

doc/guide/ddns.xml
doc/guide/dhcp4-srv.xml
doc/guide/dhcp6-srv.xml

They are described correctly now. Since it documentation I suppose we need a
ChangeLog entry:

1xxx.   [doc]     [tmark]
    Corrected the descriptions of ncr-protocol and ncr-format parameters
    in the Kea Admin Guide.
    (Trac #4117    git TBD)

Ready for review.

comment:3 Changed 4 years ago by tmark

  • Owner changed from tmark to Unassigned
  • Status changed from assigned to reviewing

comment:4 follow-up: Changed 4 years ago by sar

  • Description modified (diff)
  • Owner changed from Unassigned to tmark

The change looks fine, as does the ChangeLog? entry.

I did notice that the servers use a hyphen while the D2 uses an underscore (ncr-protocol vs ncr_protocol). This would seem to be something users might trip over in the future. Is it simple enough to change before 1.0? Should a new ticket be created for it? or maybe it was already discussed some time ago and I didn't see the discussion in which case "never mind"

I don't think we want to change this after 1.0 so creating a ticket is only useful if we can get it into 1.0.

comment:5 in reply to: ↑ 4 Changed 4 years ago by tmark

  • Resolution set to fixed
  • Status changed from reviewing to closed
  • Total Hours changed from 0 to 1

Replying to sar:

The change looks fine, as does the ChangeLog? entry.

I did notice that the servers use a hyphen while the D2 uses an underscore (ncr-protocol vs ncr_protocol). This would seem to be something users might trip over in the future. Is it simple enough to change before 1.0? Should a new ticket be created for it? or maybe it was already discussed some time ago and I didn't see the discussion in which case "never mind"

I don't think we want to change this after 1.0 so creating a ticket is only useful if we can get it into 1.0.

Actually, all of D2's parameters use underscores, not just that one. It wasn't an intentional difference and somehow nobody picked up on it. It mostly be rote effort
changing src, unit tests, .spec and doc. I've created #4202 in the proposed queue.

Changes merged with git 034c1c95b57768d5abbc7fb40cc57d7cadad21dd
Added ChangeLog entry 1050.

Ticket is closed.

comment:6 Changed 4 years ago by tomek

  • Milestone changed from Kea1.0 to Kea1.0-beta

Milestone renamed

Note: See TracTickets for help on using tickets.