Feature #2848
closed
dissect: import from tlvdump
100%
Description
Import tlvdump from ndn-cxx tools, and rename as ndn-dissect.
Changes should be minimized. Improvements will be separate issues.
Updated by Junxiao Shi over 10 years ago
- Subject changed from Print TLV structure of the supplied bytes to ndnlint: import from tlvdump
- Description updated (diff)
Original description:
This tool is equivalent to tlvdump from ndn-cxx, but I think we should use a different name, as I myself is confused about the name (resembles ndndump, but it is doing a completely different thing). tlvdump can be then removed from the library.
Suggested name: ndn-pretty-print, ndnlint (like xmllint), or something else.
Updated by Davide Pesavento over 10 years ago
I prefer a name that contains "tlv", such as tlv-pretty-print, or shorter tlv-pp (similar to perl's xml_pp).
Updated by Junxiao Shi over 10 years ago
- Subject changed from ndnlint: import from tlvdump to lint: import from tlvdump
Answer to note-2:
The official name for the packet format is NDN Packet Format, not TLV Packet Format.
(look at the title of http://named-data.net/doc/ndn-tlv/; yes I know the URI contains "tlv" but it's historical reason)
Thus, it's unnecessary to have "tlv" in the name of this tool.
Updated by Davide Pesavento over 10 years ago
I know but it's still a TLV format... anyway ok, I withdraw that suggestion. How about ndn-dissect then, or something like that?
Updated by Junxiao Shi over 10 years ago
How about ndn-dissect then, or something like that?
Before alternatives can be considered, please explain why ndnlint is wrong or misleading.
Updated by Davide Pesavento over 10 years ago
ndnlint sounds very misleading to me because the word "lint" reminds me of the static code checkers that are available for a variety of programming languages (cpplint, pylint, jslint, etc). These "linters" usually check for common programming errors, or that a given piece of code respects some programming practices or style rules.
xmllint is slightly different because XML is not a programming language. Nevertheless, its main purpose is checking that an XML document is well-formed or that it validates against a DTD or a schema (or also to test the XML parser itself). Pretty printing the output document is just a side effect.
Therefore I think using the word "lint" in the name of this tool would be misleading.
Updated by Alex Afanasyev over 10 years ago
I like ndn-dissect, as it is what we actually doing. I also agree with Davide that lint is a wrong word here. For lints, input and output are the same "languages", possibly reformatted. In our case, our input is NDN wire format and output is annotated ("dissected") wire format.
Updated by Junxiao Shi over 10 years ago
- Subject changed from lint: import from tlvdump to dissect: import from tlvdump
- Description updated (diff)
Updated by Junxiao Shi over 10 years ago
- Status changed from New to In Progress
- Assignee set to Junxiao Shi
- Estimated time set to 1.00 h
Updated by Junxiao Shi over 10 years ago
- % Done changed from 0 to 50
http://gerrit.named-data.net/2128 imports code from ndn-cxx:commit:6f7cfd02d250721567dbe88cf64f24867ba32262.
Updated by Junxiao Shi over 10 years ago
- Status changed from In Progress to Code review
- % Done changed from 50 to 100
The last commit was retargeted to import-dissect branch http://gerrit.named-data.net/2133. This branch will be used until ndn-dissect conforms to code standards and has manpages.
I have uploaded http://gerrit.named-data.net/2142 to make improvements, including namespace change, version number, etc.
Updated by Junxiao Shi over 10 years ago
- Blocks Feature #2931: README and manpages for ndn-dissect added
Updated by Junxiao Shi over 10 years ago
- Status changed from Code review to Closed