Task #3391
closedDeveloper Guide: Intro updates
100%
Description
- Update references to old face system implementation
- Include summary of management protocols, datasets, and notification streams
Updated by Alex Afanasyev almost 9 years ago
- Assignee set to Eric Newberry
- Target version set to v0.5
Updated by Eric Newberry almost 9 years ago
- Status changed from New to In Progress
Updated by Eric Newberry almost 9 years ago
Is removing the face2014
section from the manual part of this task or should I simply replace references to it with references to the new face
section?
Updated by Alex Afanasyev almost 9 years ago
Update references to new section with a brief summary of what the face system is and consists of.
Updated by Eric Newberry almost 9 years ago
Understood. Is there a review process similar to gerrit for the nfd-docs repository?
Updated by Alex Afanasyev almost 9 years ago
Not really. You can just update the document and let us know about the progress. Afterwards, we'll check the document and give you feedback/suggest changes/close the issue if everything is ok.
Updated by Junxiao Shi almost 9 years ago
Is removing the
face2014
section from the manual part of this task
face2014 is to be removed in #3397.
Of course you MAY do multiple tasks in the same commit.
The procedure for nfd-docs is much looser than code repositories.
should I simply replace references to it with references to the new
face
section?
This is not only about "references".
If there are texts that conflicts with 2015 design, they should be updated.
Updated by Eric Newberry almost 9 years ago
- Status changed from In Progress to Code review
I pushed my changes so far. I assume this is the review procedure you'd like me to follow?
Updated by Junxiao Shi almost 9 years ago
- Subject changed from Developer's Guide: Intro updates to Developer Guide: Intro updates
- Status changed from Code review to Feedback
As of nfd-docs:commit:6c602414e63d1e14398d132e273b9b80f6feea0e, "Introduction" section has the following inaccuracies.
"NFD Modules" section:
- "pending Interest table" should be called "Interest table"; see "Interest table (PIT)" section overview paragraph for why it's not "pending Interest table".
- It's unclear what does "it" refer to in "It implements a framework to support different forwarding strategies in the form of forwarding pipelines".
"Overview of NFD modules" figure:
- "dead Nonce list" table is missing.
- "status server" has been renamed "forwarder status manager".
- There's no prominent distinction between "local face" and "remote face".
- LinkService+Transport structure deserves to be mentioned.
"How Packets are Processed in NFD" section:
- "UNIX-domain socket" should be capitalized as "Unix-domain socket".
- The term "NDN-TLV" is deprecated; its replacement is just "NDN packet format".
- Transport and LinkService should be introduced.
- Nack is a network layer packet type in the context of NFD forwarding plane. It's not a subtype of Interest, so there's no such thing as "an Interest whose link-layer packet contains a Nack field" at forwarding level.
"How Management Interests are Processed in NFD" section:
- The validation of a ControlCommand Interest is performed by the dispatcher, not the manager.
- RIB Management is a separate thread but not a separate daemon.
- "NFD status" should be called "NFD general status"; it's generated on-demand, not periodically.
- Interests for a Notification stream is dropped by the dispatcher and would not reach the manager.
Updated by Eric Newberry almost 9 years ago
Junxiao Shi wrote:
"Overview of NFD modules" figure:
- "dead Nonce list" table is missing.
- "status server" has been renamed "forwarder status manager".
- There's no prominent distinction between "local face" and "remote face".
- LinkService+Transport structure deserves to be mentioned.
This figure is an image embedded in a PDF. I can't seem to find the source document the image was created from. Do you know where I can find it?
Updated by Junxiao Shi almost 9 years ago
"Overview of NFD modules" figure:
This figure is an image embedded in a PDF. I can't seem to find the source document the image was created from. Do you know where I can find it?
I have contacted the original author to commit the source file.
You may find out who uploaded the file with git blame
or git log
.
Updated by Eric Newberry almost 9 years ago
Changes related to note 10 have been pushed.
Updated by Junxiao Shi almost 9 years ago
Review of Introduction section at nfd-docs:commit:af09acb86be572703268d0e60bee55450abcaff8.
"Overview of NFD modules" figure:
- "face status publisher" is part of FaceManager, not part of "forwarder status manager"; it doesn't need to be mentioned, because StatusDataset is at the same level of ControlCommand, and ControlCommand is not separately listed.
- "FIB enumeration publisher" is part of FibManager, not part of "forwarder status manager"; it doesn't need to be mentioned, because StatusDataset is at the same level of ControlCommand, and ControlCommand is not separately listed.
- "face monitoring" has been moved to ndn-cxx.
- "network state monitoring" has been moved to ndn-cxx.
"How packets are processed in NFD" section:
- "A Face is split into a LinkService and a Transport" is better phrased as "A face is composed of a link service and a transport".
- Nack processing should be introduced either after Interest processing or after Data processing, not before Interest processing.
- What does "duplicate" mean in "If the Interest is not a duplicate"?
- It's unnecessary to mention the special case of admitting local unsolicited Data into ContentStore. This detail is irrelevant to the rest of this paragraph, and this feature is in the removal process.
"How management Interests are processed in NFD" section:
- "When NFD receives the command Interest" => "When NFD receives a control command request". At this point, there isn't a particular "command Interest" so "a" is better than "the". "control command request" is the term used in ControlCommand spec that refers to the Interest.
- "Notification streams .. operate slightly differently". The difference is not "slight".
Updated by Eric Newberry almost 9 years ago
Changes related to note 14 have been pushed.
Updated by Junxiao Shi almost 9 years ago
Review of Introduction section at nfd-docs:commit:f936e1c8fa281ba395972a861a4ad3e90c797307.
"Overview of NFD modules" figure:
- "face events" is part of FaceManager; it doesn't need to be mentioned, because Notification Stream is at the same level of ControlCommand, and ControlCommand is not separately listed.
"How packets are processed in NFD" section:
- "Transport acts as an overlay" is wrong. It's a wrapper not an overlay.
Updated by Eric Newberry almost 9 years ago
Changes related to note 16 have been pushed.
Updated by Junxiao Shi almost 9 years ago
Review of Introduction section at nfd-docs:commit:8c2ceec3492e9f7105569cd0e7dbb036885992a1.
"Overview of NFD modules" figure:
- "notification stream" should not be mentioned, because Notification Stream is at the same level of ControlCommand, and ControlCommand is not separately listed.
Updated by Eric Newberry almost 9 years ago
Revisions based upon note 18 have been pushed.
Updated by Junxiao Shi almost 9 years ago
- Status changed from Feedback to Closed
nfd-docs:commit:02f00bb05a7723c305f93723bfd5b456fc30467a looks good.