From 67683bbac9eb1446b4debb79de4632322a192b93 Mon Sep 17 00:00:00 2001
From: Martin Quinson <martin.quinson@loria.fr>
Date: Tue, 23 May 2017 17:44:46 +0200
Subject: [PATCH] give some hints about platforms that can be used in NS3

---
 examples/platforms/dogbone.xml                | 20 +++++++++++++++++++
 .../small_platform_one_link_routes.xml        |  4 ++++
 2 files changed, 24 insertions(+)

diff --git a/examples/platforms/dogbone.xml b/examples/platforms/dogbone.xml
index 65879331f0..0b6086fa06 100644
--- a/examples/platforms/dogbone.xml
+++ b/examples/platforms/dogbone.xml
@@ -1,5 +1,25 @@
 <?xml version='1.0'?>
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
+
+<!-- Describe a dogbone graph, with 4 hosts:
+  --
+  -- S1 ---[ 1 ]---                 ---[ 3 ]--- C1
+  --               \               /
+  --                R1 --[ 2 ]-- R2
+  --               /               \
+  -- S2 ---[ 4 ]---                 ---[ 5 ]--- C2
+  --
+  --
+  -- This platform is a valid NS3 platform, even if it exhibits routes of length >1,
+  -- because when you only keep the routes of length 1,
+  -- you get a graph where every host can speak to any other host.
+  --
+  -- For example, S1--C1 is (l1,l2,l3) of length >1
+  -- But it's also S1--C1 = S1--R1, R1--R2, R2--C1 which are all of length 1
+  --
+  -- http://simgrid.gforge.inria.fr/simgrid/latest/doc/pls_ns3.html
+  -->
+
 <platform version="4.1">
   <zone  id="AS0"  routing="Full">
     <host id="S1" speed="1Gf"/>
diff --git a/examples/platforms/small_platform_one_link_routes.xml b/examples/platforms/small_platform_one_link_routes.xml
index faaad678ee..3902e78422 100644
--- a/examples/platforms/small_platform_one_link_routes.xml
+++ b/examples/platforms/small_platform_one_link_routes.xml
@@ -1,5 +1,9 @@
 <?xml version='1.0'?>
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
+
+<!-- All routes of this platform are of length 1, so you can use it with the NS3 model
+     http://simgrid.gforge.inria.fr/simgrid/latest/doc/pls_ns3.html -->
+
 <platform version="4.1">
   <zone  id="AS0"  routing="Full">
     <host id="Tremblay" speed="98.095Mf"/>
-- 
2.20.1