[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [test-API 07/14] Improve more comments to tell what the program does



On 04/19/2012 10:25 AM, Osier Yang wrote:
---
  src/dist/redhat/env_inspect.py |    5 ++---
  src/exception.py               |    7 ++-----
  src/logxmlparser.py            |    7 ++-----
  src/process.py                 |    7 ++-----
  4 files changed, 8 insertions(+), 18 deletions(-)

diff --git a/src/dist/redhat/env_inspect.py b/src/dist/redhat/env_inspect.py
index 06f6408..4942b33 100644
--- a/src/dist/redhat/env_inspect.py
+++ b/src/dist/redhat/env_inspect.py
@@ -1,5 +1,7 @@
  #!/usr/bin/env python
  #
+# env_inspect.py: Check the testing environment.
+
  # Copyright (C) 2010-2012 Red Hat, Inc.
  #
  # libvirt-test-API is free software; you can redistribute it and/or
@@ -14,9 +16,6 @@
  #
  # You should have received a copy of the GNU General Public License
  # along with this program. If not, see<http://www.gnu.org/licenses/>.
-#
-# Filename: envinspect.py
-# Description: check the testing environment and state of libvirt as well

  import commands
  import libvirt
diff --git a/src/exception.py b/src/exception.py
index 3625dab..7f67602 100644
--- a/src/exception.py
+++ b/src/exception.py
@@ -1,5 +1,7 @@
  #!/usr/bin/env python
  #
+# exception.py: Exceptions for the framework.
+#
  # Copyright (C) 2010-2012 Red Hat, Inc.
  #
  # libvirt-test-API is free software; you can redistribute it and/or
@@ -14,11 +16,6 @@
  #
  # You should have received a copy of the GNU General Public License
  # along with this program. If not, see<http://www.gnu.org/licenses/>.
-#
-# Filename: exception.py
-# Summary: the exception class
-# Description: The module defines the exceptions the framework could use
-#              when fatal error occurred.

  import libvirt

diff --git a/src/logxmlparser.py b/src/logxmlparser.py
index 6e0b531..3b377ce 100644
--- a/src/logxmlparser.py
+++ b/src/logxmlparser.py
@@ -1,5 +1,7 @@
  #!/usr/bin/env python
  #
+# logxmlparser.py: Generate output log file in XML format.
+
  # Copyright (C) 2010-2012 Red Hat, Inc.
  #
  # libvirt-test-API is free software; you can redistribute it and/or
@@ -14,11 +16,6 @@
  #
  # You should have received a copy of the GNU General Public License
  # along with this program. If not, see<http://www.gnu.org/licenses/>.
-#
-# Filename: xmlparser.py
-# Summary: generate xmlfile for log management
-# Description: The module gives methods to write xml block
-#              during a testrun running

  import os
  import copy
diff --git a/src/process.py b/src/process.py
index b34c9af..71d26ea 100644
--- a/src/process.py
+++ b/src/process.py
@@ -1,5 +1,7 @@
  #!/usr/bin/env python
  #
+# process.py: Multiple process module
+#
  # Copyright (C) 2010-2012 Red Hat, Inc.
  #
  # libvirt-test-API is free software; you can redistribute it and/or
@@ -14,11 +16,6 @@
  #
  # You should have received a copy of the GNU General Public License
  # along with this program. If not, see<http://www.gnu.org/licenses/>.
-#
-# Filename: process.py
-# Summary: multiprocessing module
-# Description: If the switch of multiprocessing is on,
-#              the module will be called to fork subprocess

  import os
  import sys


       ACK

       Guannan Ren


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]