Opened 9 years ago

Closed 9 years ago

#1075 closed defect (fixed)

Rewording of CC and DATASRC messages

Reported by: stephen Owned by: stephen
Priority: low Milestone: Sprint-20110802
Component: logging Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DNS Feature Depending on Ticket:
Estimated Difficulty: 3.0 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

Miscellaneous changes to the messages in cc and datasrc (extracted from this email on bind10-dev):

CONFIG_CCSESSION_MSG_INTERNAL -- what module "will continue to run"? and reword "An unexpected exception was thrown." so is useful to admin reading this.

DATASRC_CACHE_CREATE "creating" (upcoming) or "created" (already done)? and what debug level for DATASRC_CACHE_CREATE?

DATASRC_CACHE_DESTROY being destroyed -- does that mean it is a long process?

DATASRC_ some say "cache" and others "hotspot cache" -- are they really different?

reword DATASRC_CACHE_OLD_FOUND, older instance of cache item found, replacing to "replacing existing cache item" and is it useful if doesn't indicate the name or its value?

DATASRC_MEM_ADD_WILDCARD: reword "Some special marks above each * in wildcard name are needed."

DATASRC_MEM_CNAME_TO_NONEMPTY -- what about DNSSEC records?

DATASRC_META_ADD description is not completed.

what is a "meta data source"?

DATASRC_QUERY_EMPTY_CNAME description is not completed.

DATASRC_QUERY_IS_* "a query" (add "a")?

DATASRC_QUERY_PROVENX_FAIL and others What does "PROVENX" mean? (spell out "NONEXISTENCE"?)

reword DATASRC_QUERY_SYNTH_CNAME description

DATASRC_SQLITE_PREVIOUS_NO_ZONE what is purpose to identify preceding name if not in same zone?

generic DATASRC_STATIC_BAD_CLASS ID but description is for a specific class

Subtickets

Change History (8)

comment:1 Changed 9 years ago by stephen

  • Estimated Difficulty changed from 0.0 to 3

comment:2 Changed 9 years ago by stephen

  • Owner set to stephen
  • Status changed from new to assigned

comment:3 follow-up: Changed 9 years ago by stephen

  • Owner changed from stephen to UnAssigned
  • Status changed from assigned to reviewing

CONFIG_CCSESSION_MSG_INTERNAL -- what module "will continue to run"? and reword "An unexpected exception was thrown." so is useful to admin reading this.

This was already changed.

DATASRC_CACHE_CREATE "creating" (upcoming) or "created" (already done)? and what debug level for DATASRC_CACHE_CREATE?

I'll leave it as "CREATE". The message is issued in the constructor and until that exits, the cache can't really be said to have been created.

DATASRC_CACHE_DESTROY being destroyed -- does that mean it is a long process?

Issued just prior to deleting the cache implementation object, so "being destroyed" is strictly correct.

DATASRC_ some say "cache" and others "hotspot cache" -- are they really different?

Used interchangeably.

reword DATASRC_CACHE_OLD_FOUND, older instance of cache item found, replacing to "replacing existing cache item" and is it useful if doesn't indicate the name or its value?

The name of the item found has been added. As the message will be issued after DATASRC_CACHE_INSERT (and not as a standalone message), the message text seems appropriate.

DATASRC_MEM_ADD_WILDCARD: reword "Some special marks above each * in wildcard name are needed."

Reworded.

DATASRC_MEM_CNAME_TO_NONEMPTY -- what about DNSSEC records?

There is an "XXX" (now renamed to TODO) in the code to revisit this when DNSSEC is added.

DATASRC_META_ADD description is not completed.

Reworded.

what is a "meta data source"?

I think it is a data source that can comprise multiple data sources. However, the MetaDataSrc class in data_source.h has no header comments so that is only a guess.

DATASRC_QUERY_EMPTY_CNAME description is not completed.

Reworded.

DATASRC_QUERY_IS_* "a query" (add "a")?

Added.

DATASRC_QUERY_PROVENX_FAIL and others What does "PROVENX" mean? (spell out "NONEXISTENCE"?)

Changed to "DATASRC_QUERY_PROVE_NX_FAIL"; NONEXISTENCE seems a bit too long a word to fit into the message ID.

reword DATASRC_QUERY_SYNTH_CNAME description

Altered.

DATASRC_SQLITE_PREVIOUS_NO_ZONE what is purpose to identify preceding name if not in same zone?

I think that this is part of the searching for the closest match (the method that
generates it has no header comments). If (for example) www.isc.org is not found, then a search is made for isc.org and then for org. The description for this message (and the similar DATASRC_SQLITE_PREVIOUS) have been updated.

generic DATASRC_STATIC_BAD_CLASS ID but description is for a specific class

comment:4 Changed 9 years ago by jelte

  • Owner changed from UnAssigned to jelte

comment:5 in reply to: ↑ 3 Changed 9 years ago by jelte

  • Owner changed from jelte to stephen

I have fixed a couple of typo's I found in the message file, and have no comments save the small ones below. Other thatn that it all looks ok and can be merged (unless you want Jeremy to have a look at this as well)

Replying to stephen:

DATASRC_ some say "cache" and others "hotspot cache" -- are they really different?

Used interchangeably.

just wondering if we shouldn't make a clear distinction (perhaps in the identifier)

one more tiny one:

DATASRC_SQLITE_ENCLOSURE_NOTFOUND no zone contains it

Would it be safer (and better looking) to repeat the name here instead of 'it'?

comment:6 Changed 9 years ago by stephen

  • Owner changed from stephen to jelte

DATASRC_ some say "cache" and others "hotspot cache" -- are they really different?

Used interchangeably.

just wondering if we shouldn't make a clear distinction (perhaps in the identifier)

Adding HOTSPOT_ to the identifier seemed to make it too long, so I've altered the text of the messages instead - whenever "cache" is mentioned it should always be in the context of "hotspot cache".

DATASRC_SQLITE_ENCLOSURE_NOTFOUND no zone contains it
Would it be safer (and better looking) to repeat the name here instead of 'it'?

Good idea. Updated.

comment:7 Changed 9 years ago by jelte

  • Owner changed from jelte to stephen

ok looks good, please go ahead and merge

comment:8 Changed 9 years ago by stephen

  • Resolution set to fixed
  • Status changed from reviewing to closed

Merged in commit aa4405d57bec097972c4d5b60d1cfd6a06f84bf1

Note: See TracTickets for help on using tickets.