From 7d4b7b7f47f08d63527f951c4b2d69cb815cecd0 Mon Sep 17 00:00:00 2001
From: Bob Lantz <rlantz@cs.stanford.edu>
Date: Fri, 5 Feb 2010 17:18:08 -0800
Subject: [PATCH] Comment tweaks and additions.

---
 mininet/net.py   |  1 +
 mininet/node.py  | 32 +++++++++++++++++++++++++++++++-
 mininet/util.py  |  1 +
 mininet/xterm.py |  4 ++--
 4 files changed, 35 insertions(+), 3 deletions(-)

diff --git a/mininet/net.py b/mininet/net.py
index 7a6bda5b..ab08bd8f 100755
--- a/mininet/net.py
+++ b/mininet/net.py
@@ -14,6 +14,7 @@
 top of a single Linux kernel.
 
 Each host has:
+
 A virtual console (pipes to a shell)
 A virtual interfaces (half of a veth pair)
 A parent shell (and possibly some child processes) in a namespace
diff --git a/mininet/node.py b/mininet/node.py
index f8ff55dd..d93b571f 100644
--- a/mininet/node.py
+++ b/mininet/node.py
@@ -1,5 +1,35 @@
 #!/usr/bin/env python
-"Node objects for Mininet."
+
+"""
+Node objects for Mininet.
+
+Nodes provide a simple abstraction for interacting with
+hosts, switches and controllers. Local nodes are simply
+one or more processes on the local machine.
+
+Node: superclass for all (currently only local) network nodes.
+
+Host: a virtual host.
+
+Switch: superclass for switch nodes.
+
+UserSwitch: a switch using the user-space switch from the OpenFlow
+    reference implementation.
+
+KernelSwitch: a switch using the kernel switch from the OpenFlow reference
+    implementation.
+
+OVSSwitch: a switch using the OpenVSwitch OpenFlow-compatible switch
+    implementation (openvswitch.org).
+
+Controller: superclass for OpenFlow controllers. The default controller
+    is controller(8) from the reference implementation.
+
+NOXController: a controller node using NOX (noxrepo.org).
+
+RemoteController: a remote controller node, which may use any
+    arbitrary OpenFlow-compatible controller.
+"""
 
 from subprocess import Popen, PIPE, STDOUT
 import os
diff --git a/mininet/util.py b/mininet/util.py
index c12417cb..f60b9df1 100644
--- a/mininet/util.py
+++ b/mininet/util.py
@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+
 "Utility functions for Mininet."
 
 from time import sleep
diff --git a/mininet/xterm.py b/mininet/xterm.py
index ae4ad0d8..d53dc897 100644
--- a/mininet/xterm.py
+++ b/mininet/xterm.py
@@ -2,9 +2,9 @@
 
 """
 XTerm creation and cleanup.
-Utility functions to run an xterm ( connected via screen( 1 ) ) on each host.
+Utility functions to run an xterm (connected via screen(1)) on each host.
 
-Requires xterm( 1 ) and GNU screen( 1 ).
+Requires xterm(1) and GNU screen(1).
 """
 
 import re
-- 
GitLab