[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 6/6] scripts/dump-guest-memory.py: Fix module docstr
From: |
Janosch Frank |
Subject: |
[Qemu-devel] [PATCH 6/6] scripts/dump-guest-memory.py: Fix module docstring |
Date: |
Fri, 22 Jan 2016 13:08:40 +0100 |
The module docstring is changed into a multi-line comment to comply
with pep 257.
The comment about the docstring that gets used by gdb to print the
help is moved to the location of the docstring.
Signed-off-by: Janosch Frank <address@hidden>
---
scripts/dump-guest-memory.py | 35 ++++++++++++++++++-----------------
1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/scripts/dump-guest-memory.py b/scripts/dump-guest-memory.py
index 7acce65..f274bf8 100644
--- a/scripts/dump-guest-memory.py
+++ b/scripts/dump-guest-memory.py
@@ -1,20 +1,17 @@
-# This python script adds a new gdb command, "dump-guest-memory". It
-# should be loaded with "source dump-guest-memory.py" at the (gdb)
-# prompt.
-#
-# Copyright (C) 2013, Red Hat, Inc.
-#
-# Authors:
-# Laszlo Ersek <address@hidden>
-# Janosch Frank <address@hidden>
-#
-# This work is licensed under the terms of the GNU GPL, version 2 or later. See
-# the COPYING file in the top-level directory.
-#
-# The leading docstring doesn't have idiomatic Python formatting. It is
-# printed by gdb's "help" command (the first line is printed in the
-# "help data" summary), and it should match how other help texts look in
-# gdb.
+"""
+This python script adds a new gdb command, "dump-guest-memory". It
+should be loaded with "source dump-guest-memory.py" at the (gdb)
+prompt.
+
+Copyright (C) 2013, Red Hat, Inc.
+
+Authors:
+ Laszlo Ersek <address@hidden>
+ Janosch Frank <address@hidden>
+
+This work is licensed under the terms of the GNU GPL, version 2 or later. See
+the COPYING file in the top-level directory.
+"""
import ctypes
@@ -431,6 +428,10 @@ def get_guest_phys_blocks():
return guest_phys_blocks
+# The leading docstring doesn't have idiomatic Python formatting. It is
+# printed by gdb's "help" command (the first line is printed in the
+# "help data" summary), and it should match how other help texts look in
+# gdb.
class DumpGuestMemory(gdb.Command):
"""Extract guest vmcore from qemu process coredump.
--
2.3.0
- [Qemu-devel] [PATCH 0/6] scripts/dump-guest-memory.py: Add multi-arch support, Janosch Frank, 2016/01/22
- [Qemu-devel] [PATCH 5/6] scripts/dump-guest-memory.py: Introduce multi-arch support, Janosch Frank, 2016/01/22
- [Qemu-devel] [PATCH 6/6] scripts/dump-guest-memory.py: Fix module docstring,
Janosch Frank <=
- [Qemu-devel] [PATCH 4/6] scripts/dump-guest-memory.py: Cleanup functions, Janosch Frank, 2016/01/22
- [Qemu-devel] [PATCH 2/6] scripts/dump-guest-memory.py: Make methods functions, Janosch Frank, 2016/01/22
- [Qemu-devel] [PATCH 3/6] scripts/dump-guest-memory.py: Improve python 3 compatibility, Janosch Frank, 2016/01/22
- [Qemu-devel] [PATCH 1/6] scripts/dump-guest-memory.py: Move constants to the top, Janosch Frank, 2016/01/22
- Re: [Qemu-devel] [PATCH 0/6] scripts/dump-guest-memory.py: Add multi-arch support, Paolo Bonzini, 2016/01/22