[libvirt] [PATCH 2/2] maint: Remove not-so-much informative block commentaries

Erik Skultety eskultet at redhat.com
Tue Oct 17 15:24:31 UTC 2017


There were a bunch of commentary blocks that were literally useless in
terms of describing what the code following them does, since most of
them were documenting "the obvious" or it just wouldn't help at all.

Signed-off-by: Erik Skultety <eskultet at redhat.com>
---
 daemon/remote.c             |  7 -------
 src/network/bridge_driver.c |  2 --
 src/util/virconf.c          | 33 ---------------------------------
 src/util/virerror.h         |  5 -----
 src/util/virxml.c           |  6 ------
 src/vbox/vbox_XPCOMCGlue.c  |  9 ---------
 src/xen/xend_internal.c     | 11 -----------
 src/xen/xs_internal.c       | 10 ----------
 src/xenconfig/xen_sxpr.c    |  5 -----
 9 files changed, 88 deletions(-)

diff --git a/daemon/remote.c b/daemon/remote.c
index fd8542120..3f7d2d344 100644
--- a/daemon/remote.c
+++ b/daemon/remote.c
@@ -3750,10 +3750,6 @@ remoteDispatchAuthPolkit(virNetServerPtr server,
 }
 
 
-/***************************************************************
- *     NODE INFO APIS
- **************************************************************/
-
 static int
 remoteDispatchNodeDeviceGetParent(virNetServerPtr server ATTRIBUTE_UNUSED,
                                   virNetServerClientPtr client ATTRIBUTE_UNUSED,
@@ -3864,9 +3860,6 @@ remoteDispatchConnectUnregisterCloseCallback(virNetServerPtr server ATTRIBUTE_UN
     return rv;
 }
 
-/***************************
- * Register / deregister events
- ***************************/
 static int
 remoteDispatchConnectDomainEventRegister(virNetServerPtr server ATTRIBUTE_UNUSED,
                                          virNetServerClientPtr client,
diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c
index 530d00ff3..fcaa66df9 100644
--- a/src/network/bridge_driver.c
+++ b/src/network/bridge_driver.c
@@ -4286,8 +4286,6 @@ networkRegister(void)
 }
 
 
-/********************************************************/
-
 /* A unified function to log network connections and disconnections */
 
 static void
diff --git a/src/util/virconf.c b/src/util/virconf.c
index a88cc9901..5822ee45e 100644
--- a/src/util/virconf.c
+++ b/src/util/virconf.c
@@ -44,12 +44,6 @@
 
 VIR_LOG_INIT("util.conf");
 
-/************************************************************************
- *                                                                      *
- *      Structures and macros used by the mini parser                   *
- *                                                                      *
- ************************************************************************/
-
 typedef struct _virConfParserCtxt virConfParserCtxt;
 typedef virConfParserCtxt *virConfParserCtxtPtr;
 
@@ -75,12 +69,6 @@ struct _virConfParserCtxt {
   do { while ((ctxt->cur < ctxt->end) && (c_isblank(CUR)))              \
           ctxt->cur++; } while (0)
 
-/************************************************************************
- *                                                                      *
- *              Structures used by configuration data                   *
- *                                                                      *
- ************************************************************************/
-
 VIR_ENUM_IMPL(virConf, VIR_CONF_LAST,
               "*unexpected*",
               "long",
@@ -133,12 +121,6 @@ virConfErrorHelper(const char *file, const char *func, size_t line,
 }
 
 
-/************************************************************************
- *                                                                      *
- *              Structures allocations and deallocations                *
- *                                                                      *
- ************************************************************************/
-
 /**
  * virConfFreeList:
  * @list: the list to free
@@ -260,11 +242,6 @@ virConfAddEntry(virConfPtr conf, char *name, virConfValuePtr value, char *comm)
     return ret;
 }
 
-/************************************************************************
- *                                                                      *
- *                      Serialization                                   *
- *                                                                      *
- ************************************************************************/
 
 /**
  * virConfSaveValue:
@@ -353,11 +330,6 @@ virConfSaveEntry(virBufferPtr buf, virConfEntryPtr cur)
     return 0;
 }
 
-/************************************************************************
- *                                                                      *
- *                      The parser core                                 *
- *                                                                      *
- ************************************************************************/
 
 /**
  * virConfParseLong:
@@ -754,11 +726,6 @@ virConfParse(const char *filename, const char *content, int len,
     return NULL;
 }
 
-/************************************************************************
- *                                                                      *
- *                      The module entry points                         *
- *                                                                      *
- ************************************************************************/
 
 /* 10 MB limit on config file size as a sanity check */
 #define MAX_CONFIG_FILE_SIZE (1024*1024*10)
diff --git a/src/util/virerror.h b/src/util/virerror.h
index 054f50fd7..3201d5cec 100644
--- a/src/util/virerror.h
+++ b/src/util/virerror.h
@@ -27,11 +27,6 @@
 extern virErrorFunc virErrorHandler;
 extern void *virUserData;
 
-/************************************************************************
- *                                                                      *
- *              API for error handling                                  *
- *                                                                      *
- ************************************************************************/
 int virErrorInitialize(void);
 void virRaiseErrorFull(const char *filename,
                        const char *funcname,
diff --git a/src/util/virxml.c b/src/util/virxml.c
index a7c28b1e3..1ff1e3653 100644
--- a/src/util/virxml.c
+++ b/src/util/virxml.c
@@ -50,12 +50,6 @@ struct virParserData {
 };
 
 
-/************************************************************************
- *                                                                      *
- * Wrappers around libxml2 XPath specific functions                     *
- *                                                                      *
- ************************************************************************/
-
 /**
  * virXPathString:
  * @xpath: the XPath string to evaluate
diff --git a/src/vbox/vbox_XPCOMCGlue.c b/src/vbox/vbox_XPCOMCGlue.c
index ff03279ed..cae6d0c62 100644
--- a/src/vbox/vbox_XPCOMCGlue.c
+++ b/src/vbox/vbox_XPCOMCGlue.c
@@ -26,9 +26,6 @@
  * additional information or have any questions.
  */
 
-/*******************************************************************************
-*   Header Files                                                               *
-*******************************************************************************/
 
 #include <config.h>
 
@@ -48,9 +45,6 @@
 
 VIR_LOG_INIT("vbox.vbox_XPCOMCGlue");
 
-/*******************************************************************************
-*   Defined Constants And Macros                                               *
-*******************************************************************************/
 #if defined(__linux__) || defined(__linux_gnu__) || defined(__sun__) || \
     defined(__FreeBSD__) || defined(__OpenBSD__) || \
     defined(__FreeBSD_kernel__)
@@ -64,9 +58,6 @@ VIR_LOG_INIT("vbox.vbox_XPCOMCGlue");
 #endif
 
 
-/*******************************************************************************
-*   Global Variables                                                           *
-*******************************************************************************/
 /** The dlopen handle for VBoxXPCOMC. */
 static void *hVBoxXPCOMC;
 /** Pointer to the VBoxXPCOMC function table. */
diff --git a/src/xen/xend_internal.c b/src/xen/xend_internal.c
index ccb1478b3..e4edfd6f8 100644
--- a/src/xen/xend_internal.c
+++ b/src/xen/xend_internal.c
@@ -1122,17 +1122,6 @@ sexpr_to_domain(virConnectPtr conn ATTRIBUTE_UNUSED, const struct sexpr *root)
 }
 
 
-/*****************************************************************
- ******
- ******
- ******
- ******
-             Refactored
- ******
- ******
- ******
- ******
- *****************************************************************/
 /**
  * xenDaemonOpen:
  * @conn: an existing virtual connection block
diff --git a/src/xen/xs_internal.c b/src/xen/xs_internal.c
index 60d35ebcd..353169da0 100644
--- a/src/xen/xs_internal.c
+++ b/src/xen/xs_internal.c
@@ -59,11 +59,6 @@ VIR_LOG_INIT("xen.xs_internal");
 static void xenStoreWatchEvent(int watch, int fd, int events, void *data);
 static void xenStoreWatchListFree(xenStoreWatchListPtr list);
 
-/************************************************************************
- *                                                                      *
- *              Helper internal APIs                                    *
- *                                                                      *
- ************************************************************************/
 
 /**
  * virDomainDoStoreQuery:
@@ -91,11 +86,6 @@ virDomainDoStoreQuery(virConnectPtr conn, int domid, const char *path)
     return xs_read(priv->xshandle, 0, &s[0], &len);
 }
 
-/************************************************************************
- *                                                                      *
- *              Canonical internal APIs                                 *
- *                                                                      *
- ************************************************************************/
 /**
  * xenStoreOpen:
  * @conn: pointer to the connection block
diff --git a/src/xenconfig/xen_sxpr.c b/src/xenconfig/xen_sxpr.c
index fefa61ac2..358d0cbef 100644
--- a/src/xenconfig/xen_sxpr.c
+++ b/src/xenconfig/xen_sxpr.c
@@ -70,11 +70,6 @@ int xenGetDomIdFromSxpr(const struct sexpr *root, int *id)
     return 0;
 }
 
-/*****************************************************************
- ******
- ****** Parsing of S-Expression into virDomainDef objects
- ******
- *****************************************************************/
 
 /**
  * xenParseSxprOS:
-- 
2.13.6




More information about the libvir-list mailing list