From 4d82692800314193b48d3dbb06cbecf168699a48 Mon Sep 17 00:00:00 2001
From: Davide Pesavento <davide.pesavento@lip6.fr>
Date: Sun, 11 Feb 2018 23:05:48 -0500
Subject: [PATCH] docs: update XML Schema for nfdc status after the recent
 changes

Plus some minor docs updates

Change-Id: Ieb8d6f520c47c022087354d745e33fff58c2d875
---
 docs/_static/nfd-status.xsd          | 34 ++++++++++++++++------------
 docs/local-prefix-discovery.rst      | 32 ++++++++++++++++++++++++++
 docs/manpages.rst                    |  6 ++---
 docs/misc/local-prefix-discovery.rst | 32 --------------------------
 docs/schema.rst                      |  4 ++--
 5 files changed, 57 insertions(+), 51 deletions(-)
 create mode 100644 docs/local-prefix-discovery.rst
 delete mode 100644 docs/misc/local-prefix-discovery.rst

diff --git a/docs/_static/nfd-status.xsd b/docs/_static/nfd-status.xsd
index 2ad1eebf..bd03535f 100644
--- a/docs/_static/nfd-status.xsd
+++ b/docs/_static/nfd-status.xsd
@@ -1,19 +1,19 @@
 <?xml version="1.0"?>
 
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
-targetNamespace="ndn:/localhost/nfd/status/1" xmlns:nfd="ndn:/localhost/nfd/status/1"
-elementFormDefault="qualified">
+           xmlns:nfd="ndn:/localhost/nfd/status/1"
+           targetNamespace="ndn:/localhost/nfd/status/1"
+           elementFormDefault="qualified">
 
-<xs:simpleType name="emptyType">
-  <xs:restriction base="xs:string">
-    <xs:maxLength value="0"/>
-  </xs:restriction>
-</xs:simpleType>
+<xs:complexType name="emptyType">
+  <xs:sequence/>
+</xs:complexType>
 
 <xs:complexType name="unidirectionalPacketCountersType">
   <xs:sequence>
     <xs:element type="xs:nonNegativeInteger" name="nInterests"/>
-    <xs:element type="xs:nonNegativeInteger" name="nDatas"/>
+    <xs:element type="xs:nonNegativeInteger" name="nData"/>
+    <xs:element type="xs:nonNegativeInteger" name="nNacks"/>
   </xs:sequence>
 </xs:complexType>
 
@@ -33,7 +33,6 @@ elementFormDefault="qualified">
 
 <xs:complexType name="generalStatusType">
   <xs:sequence>
-    <xs:element type="xs:anyURI" name="nfdId"/>
     <xs:element type="xs:string" name="version"/>
     <xs:element type="xs:dateTime" name="startTime"/>
     <xs:element type="xs:dateTime" name="currentTime"/>
@@ -124,15 +123,15 @@ elementFormDefault="qualified">
 
 <xs:complexType name="ribFlagsType">
   <xs:sequence>
-    <xs:element type="xs:string" name="childInherit" minOccurs="0"/>
-    <xs:element type="xs:string" name="ribCapture" minOccurs="0"/>
+    <xs:element type="nfd:emptyType" name="childInherit" minOccurs="0"/>
+    <xs:element type="nfd:emptyType" name="ribCapture" minOccurs="0"/>
   </xs:sequence>
 </xs:complexType>
 
 <xs:complexType name="routeType">
   <xs:sequence>
     <xs:element type="xs:nonNegativeInteger" name="faceId"/>
-    <xs:element type="xs:nonNegativeInteger" name="origin"/>
+    <xs:element type="xs:string" name="origin"/>
     <xs:element type="xs:nonNegativeInteger" name="cost"/>
     <xs:element type="nfd:ribFlagsType" name="flags"/>
     <xs:element type="xs:duration" name="expirationPeriod" minOccurs="0"/>
@@ -158,6 +157,13 @@ elementFormDefault="qualified">
   </xs:sequence>
 </xs:complexType>
 
+<xs:complexType name="csType">
+  <xs:sequence>
+    <xs:element type="xs:nonNegativeInteger" name="nHits"/>
+    <xs:element type="xs:nonNegativeInteger" name="nMisses"/>
+  </xs:sequence>
+</xs:complexType>
+
 <xs:complexType name="strategyType">
   <xs:sequence>
     <xs:element type="xs:anyURI" name="name"/>
@@ -173,8 +179,7 @@ elementFormDefault="qualified">
 
 <xs:complexType name="strategyChoicesType">
   <xs:sequence>
-    <xs:element type="nfd:strategyChoiceType" name="strategyChoice"
-                maxOccurs="unbounded" minOccurs="0"/>
+    <xs:element type="nfd:strategyChoiceType" name="strategyChoice" maxOccurs="unbounded" minOccurs="0"/>
   </xs:sequence>
 </xs:complexType>
 
@@ -186,6 +191,7 @@ elementFormDefault="qualified">
       <xs:element type="nfd:facesType" name="faces"/>
       <xs:element type="nfd:fibType" name="fib"/>
       <xs:element type="nfd:ribType" name="rib"/>
+      <xs:element type="nfd:csType" name="cs"/>
       <xs:element type="nfd:strategyChoicesType" name="strategyChoices"/>
     </xs:sequence>
   </xs:complexType>
diff --git a/docs/local-prefix-discovery.rst b/docs/local-prefix-discovery.rst
new file mode 100644
index 00000000..868d2bba
--- /dev/null
+++ b/docs/local-prefix-discovery.rst
@@ -0,0 +1,32 @@
+.. _local-prefix-discovery:
+
+Local hub prefix discovery
+==========================
+
+Some applications need to discover the prefix(es) under which they can publish data
+/ which Interests the local hub will be able to forward down to the application.
+In order to discover that, applications need to send an Interest for
+``/localhop/nfd/rib/routable-prefixes`` prefix. Response data to the
+Interest contains a list of prefixes and should be encoded as follows:
+
+::
+
+    Response ::= DATA-TYPE TLV-LENGTH
+                   Name (= /localhop/nfd/rib/routable-prefixes/[version]/[segment])
+                   MetaInfo (= ResponseMetaInfo)
+                   Content (= ResponseContent)
+                   Signature
+
+    ResponseMetaInfo ::= META-INFO-TYPE TLV-LENGTH
+                           ContentType (= BLOB)
+                           FreshnessPeriod (= 5000)
+
+    ResponseContent ::= Name+
+
+.. note::
+    ResponseContent should contain at least one ``Name``, which should be routable
+    towards the face from which the request has been received.  The requester may
+    process the list of returned names and pick whichever it wants to use.
+
+For now, the ``/localhop/nfd/rib/routable-prefixes`` data is served by
+:ref:`ndn-autoconfig-server`.
diff --git a/docs/manpages.rst b/docs/manpages.rst
index 1e14cbf0..b02f2817 100644
--- a/docs/manpages.rst
+++ b/docs/manpages.rst
@@ -11,13 +11,13 @@ Manpages
    manpages/nfdc-route
    manpages/nfdc-cs
    manpages/nfdc-strategy
+   manpages/nfd-asf-strategy
    manpages/nfd-status
-   schema
    manpages/nfd-status-http-server
+   schema
    manpages/ndn-autoconfig
    manpages/ndn-autoconfig.conf
    manpages/ndn-autoconfig-server
-   misc/local-prefix-discovery
+   local-prefix-discovery
    manpages/nfd-autoreg
-   manpages/nfd-asf-strategy
    :maxdepth: 1
diff --git a/docs/misc/local-prefix-discovery.rst b/docs/misc/local-prefix-discovery.rst
deleted file mode 100644
index db4e6557..00000000
--- a/docs/misc/local-prefix-discovery.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-.. _local-prefix-discovery:
-
-Discover local hub prefix
-=========================
-
-Some applications need to discover prefix(es) under which they can publish data
-/ which Interests local hub will be able to forward down to the application.
-In order to discover that, applications need to send an interest for
-``/localhop/nfd/rib/routable-prefixes`` prefix. Response data to the
-interest contains a list of prefixes and should be encoded as:
-
-::
-
-    Response ::= DATA-TYPE TLV-LENGTH
-                 Name (= /localhop/nfd/rib/routable-prefixes/[version]/[segment])
-                 MetaInfo (= ResponseMetaInfo)
-                 Content (= ResponseContent)
-                 Signature
-
-    ResponseMetaInfo ::= META-INFO-TYPE TLV-LENGTH
-                         ContentType (= DATA)
-                         FreshnessPeriod (= 5000)
-
-    ResponseContent ::= Name+
-
-.. note::
-    ResponseContent should contain at least one Name, which should be routable
-    towards the face from which the request has been received.  The requester may
-    process list of the returned names and pick whichever it wants to use.
-
-For now, the ``/localhop/nfd/rib/routable-prefixes`` data is served by
-:ref:`ndn-autoconfig-server`.
diff --git a/docs/schema.rst b/docs/schema.rst
index f4c7611f..4006afd6 100644
--- a/docs/schema.rst
+++ b/docs/schema.rst
@@ -4,9 +4,9 @@ NFD Status XML Schema
 =====================
 
 The NFD status XML schema describes the structure of the NFD status XML
-document generated by command ``nfd-status``.
+document generated by the command ``nfdc status report xml``.
 
-Users can use this schema to validate the generated XML document.
+This schema can be used to validate the generated XML document.
 
 .. literalinclude:: _static/nfd-status.xsd
    :language: xml