From 4c6fe5602edcbd9857a846e5b13a21d5c671a2c8 Mon Sep 17 00:00:00 2001
From: Vratko Polak <vrpolak@cisco.com>
Date: Fri, 13 Apr 2018 19:45:33 +0200
Subject: Fix warnings reported by gen_doc.sh

+ Docstring warnings fixed.
 + Multiline param descriptions indented by 4 spaces.
 - Except the PacketVerifier.py one
  - I have tried several quote-like blocks, nothing works.
- Rst warnings not fixed.
 - How can I fix them? They refer to temporarily created files.
+ Other improvements:
 + Python lines no longer than 80 characters.
 + :return: -> :returns:
 + Notes before params.
 + :raises
  + closing colon after exception class.
  + Description is a sentence.
  + Present tense in conditional sentences.
+ Bumped copyright year in edited files.

Change-Id: I462c194eeecb666dc146e26858486a07c990be9b
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
---
 resources/libraries/python/QemuUtils.py | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

(limited to 'resources/libraries/python/QemuUtils.py')

diff --git a/resources/libraries/python/QemuUtils.py b/resources/libraries/python/QemuUtils.py
index 42ccb8c9dd..99fb7f4b8d 100644
--- a/resources/libraries/python/QemuUtils.py
+++ b/resources/libraries/python/QemuUtils.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
@@ -166,7 +166,7 @@ class QemuUtils(object):
         """Set scheduler policy to SCHED_RR with priority 1 for all Qemu CPU
         processes.
 
-       :raises RuntimeError: Set scheduler policy failed.
+        :raises RuntimeError: Set scheduler policy failed.
         """
         qemu_cpus = self._qemu_qmp_exec('query-cpus')['return']
 
@@ -199,7 +199,7 @@ class QemuUtils(object):
         :param socket: Path of the unix socket.
         :param server: If True the socket shall be a listening socket.
         :param mac: Vhost-user interface MAC address (optional, otherwise is
-        used auto-generated MAC 52:54:00:00:xx:yy).
+            used auto-generated MAC 52:54:00:00:xx:yy).
         :param jumbo_frames: Set True if jumbo frames are used in the test.
         :type socket: str
         :type server: bool
@@ -247,7 +247,7 @@ class QemuUtils(object):
 
         :param cmd: QMP command to execute.
         :type cmd: str
-        :return: Command output in python representation of JSON format. The
+        :returns: Command output in python representation of JSON format. The
             { "return": {} } response is QMP's success response. An error
             response will contain the "error" keyword instead of "return".
         """
@@ -449,7 +449,7 @@ class QemuUtils(object):
 
         :returns: Default size of free huge pages in system.
         :rtype: int
-        :raises: RuntimeError if reading failed for three times.
+        :raises RuntimeError: If reading failed for three times.
         """
         # TODO: remove to dedicated library
         cmd_huge_size = "grep Hugepagesize /proc/meminfo | awk '{ print $2 }'"
@@ -473,7 +473,7 @@ class QemuUtils(object):
         :type huge_size: int
         :returns: Number of free huge pages in system.
         :rtype: int
-        :raises: RuntimeError if reading failed for three times.
+        :raises RuntimeError: If reading failed for three times.
         """
         # TODO: add numa aware option
         # TODO: remove to dedicated library
@@ -499,7 +499,7 @@ class QemuUtils(object):
         :type huge_size: int
         :returns: Total number of huge pages in system.
         :rtype: int
-        :raises: RuntimeError if reading failed for three times.
+        :raises RuntimeError: If reading failed for three times.
         """
         # TODO: add numa aware option
         # TODO: remove to dedicated library
@@ -521,10 +521,11 @@ class QemuUtils(object):
     def qemu_start(self):
         """Start QEMU and wait until VM boot.
 
-        :return: VM node info.
-        :rtype: dict
         .. note:: First set at least node to run QEMU on.
         .. warning:: Starts only one VM on the node.
+
+        :returns: VM node info.
+        :rtype: dict
         """
         # Qemu binary path
         bin_path = '{0}{1}'.format(self._qemu_path, self._qemu_bin)
@@ -659,7 +660,7 @@ class QemuUtils(object):
             - watchdog: watchdog action has been triggered
             - guest-panicked: panicked as a result of guest OS panic
 
-        :return: VM status.
+        :returns: VM status.
         :rtype: str
         """
         out = self._qemu_qmp_exec('query-status')
@@ -682,7 +683,7 @@ class QemuUtils(object):
         :type node: dict
         :type force_install: bool
         :type apply_patch: bool
-        :raises: RuntimeError if building QEMU failed.
+        :raises RuntimeError: If building QEMU failed.
         """
         ssh = SSH()
         ssh.connect(node)
-- 
cgit 1.2.3-korg