LXC fix wrong or out-of-date function descriptions

* src/lxc/lxc_container.c src/lxc/lxc_controller.c src/lxc/lxc_driver.c
  src/lxc/veth.c: fix broken function comments

diff --git a/src/lxc/lxc_container.c b/src/lxc/lxc_container.c
index f4381e7411df64f368025b36b687f4ab9e525f61..2910efc4d4b8893744f9802512a04e6430201486 100644 (file)
--- a/src/lxc/lxc_container.c
+++ b/src/lxc/lxc_container.c
@@ -91,7 +91,7 @@ struct __lxc_child_argv {
 
 /**
  * lxcContainerExecInit:
- * @vmDef: Ptr to vm definition structure
+ * @vmDef: pointer to vm definition structure
  *
  * Exec the container init string. The container init will replace then
  * be running in the current process
@@ -110,8 +110,8 @@ static int lxcContainerExecInit(virDomainDefPtr vmDef)
 
 /**
  * lxcContainerSetStdio:
- * @control: the conrol FD
- * @ttyPath: Name of tty to set as the container console
+ * @control: control FD from parent
+ * @ttyfd: FD of tty to set as the container console
  *
  * Sets the given tty as the primary conosole for the container as well as
  * stdout, stdin and stderr.
@@ -168,7 +168,7 @@ cleanup:
 
 /**
  * lxcContainerSendContinue:
- * @monitor: control FD to child
+ * @control: control FD to child
  *
  * Sends the continue message via the socket pair stored in the vm
  * structure.
@@ -196,7 +196,7 @@ error_out:
 
 /**
  * lxcContainerWaitForContinue:
- * @control: control FD from parent
+ * @control: Control FD from parent
  *
  * This function will wait for the container continue message from the
  * parent process.  It will send this message on the socket pair stored in
@@ -225,8 +225,9 @@ static int lxcContainerWaitForContinue(int control)
 
 
 /**
- * lxcEnableInterfaces:
- * @vm: Pointer to vm structure
+ * lxcContainerEnableInterfaces:
+ * @nveths: number of interfaces
+ * @veths: interface names
  *
  * This function will enable the interfaces for this container.
  *
@@ -696,8 +697,8 @@ static int lxcContainerDropCapabilities(void)
 
 
 /**
- * lxcChild:
- * @argv: Pointer to container arguments
+ * lxcContainerChild:
+ * @data: pointer to container arguments
  *
  * This function is run in the process clone()'d in lxcStartContainer.
  * Perform a number of container setup tasks:
@@ -776,8 +777,11 @@ static int userns_supported(void)
 
 /**
  * lxcContainerStart:
- * @driver: pointer to driver structure
- * @vm: pointer to virtual machine structure
+ * @def: pointer to virtual machine structure
+ * @nveths: number of interfaces
+ * @veths: interface names
+ * @control: control FD to the container
+ * @ttyPath: path of tty to set as the container console
  *
  * Starts a container process by calling clone() with the namespace flags
  *

diff --git a/src/lxc/lxc_controller.c b/src/lxc/lxc_controller.c
index 545f7182b284a9c45a6a2957df383ebc9382a124..f5e0a5a2fed887377c2a198f57fa6c3422f7cb46 100644 (file)
--- a/src/lxc/lxc_controller.c
+++ b/src/lxc/lxc_controller.c
@@ -269,9 +269,11 @@ typedef struct _lxcTtyForwardFd_t {
 } lxcTtyForwardFd_t;
 
 /**
- * lxcTtyForward:
- * @appPty: Open fd for application facing Pty
- * @contPty: Open fd for container facing Pty
+ * lxcControllerMain
+ * @monitor: server socket fd to accept client requests
+ * @client: initial client which is the libvirtd daemon
+ * @appPty: open fd for application facing Pty
+ * @contPty: open fd for container facing Pty
  *
  * Forwards traffic between fds.  Data read from appPty will be written to contPty
  * This process loops forever.
@@ -461,8 +463,8 @@ static int lxcControllerMoveInterfaces(unsigned int nveths,
 
 /**
  * lxcCleanupInterfaces:
- * @conn: pointer to connection
- * @vm: pointer to virtual machine structure
+ * @nveths: number of interfaces
+ * @veths: interface names
  *
  * Cleans up the container interfaces by deleting the veth device pairs.
  *

diff --git a/src/lxc/lxc_driver.c b/src/lxc/lxc_driver.c
index 9ab94bf221107df56711d986c752aff0651b2461..0dd3a08e6e527dd618ffde700d660f68e3845c82 100644 (file)
--- a/src/lxc/lxc_driver.c
+++ b/src/lxc/lxc_driver.c
@@ -614,7 +614,9 @@ cleanup:
 
 /**
  * lxcVmCleanup:
- * @vm: Ptr to VM to clean up
+ * @conn: pointer to connection
+ * @driver: pointer to driver structure
+ * @vm: pointer to VM to clean up
  *
  * waitpid() on the container process.  kill and wait the tty process
  * This is called by both lxcDomainDestroy and lxcSigHandler when a
@@ -622,7 +624,7 @@ cleanup:
  *
  * Returns 0 on success or -1 in case of error
  */
-static int lxcVMCleanup(virConnectPtr conn,
+static int lxcVmCleanup(virConnectPtr conn,
                         lxc_driver_t *driver,
                         virDomainObjPtr  vm)
 {
@@ -683,7 +685,10 @@ static int lxcVMCleanup(virConnectPtr conn,
 
 /**
  * lxcSetupInterfaces:
+ * @conn: pointer to connection
  * @def: pointer to virtual machine structure
+ * @nveths: number of interfaces
+ * @veths: interface names
  *
  * Sets up the container interfaces by creating the veth device pairs and
  * attaching the parent end to the appropriate bridge.  The container end
@@ -860,7 +865,7 @@ static int lxcVmTerminate(virConnectPtr conn,
 
     vm->state = VIR_DOMAIN_SHUTDOWN;
 
-    return lxcVMCleanup(conn, driver, vm);
+    return lxcVmCleanup(conn, driver, vm);
 }
 
 static void lxcMonitorEvent(int watch,
@@ -1344,7 +1349,7 @@ cleanup:
 
 /**
  * lxcDomainShutdown:
- * @dom: Ptr to domain to shutdown
+ * @dom: pointer to domain to shutdown
  *
  * Sends SIGINT to container root process to request it to shutdown
  *
@@ -1477,7 +1482,7 @@ static void lxcDomainEventQueue(lxc_driver_t *driver,
 
 /**
  * lxcDomainDestroy:
- * @dom: Ptr to domain to destroy
+ * @dom: pointer to domain to destroy
  *
  * Sends SIGKILL to container root process to terminate the container
  *

diff --git a/src/lxc/veth.c b/src/lxc/veth.c
index b15df8db6199d57214d260984765be0aec29830e..5984950ce10ded6487d22ce86bc7e7df13011a30 100644 (file)
--- a/src/lxc/veth.c
+++ b/src/lxc/veth.c
@@ -182,12 +182,12 @@ error_out:
 
 /**
  * moveInterfaceToNetNs:
- * @interface: name of device
+ * @iface: name of device
  * @pidInNs: PID of process in target net namespace
  *
  * Moves the given device into the target net namespace specified by the given
  * pid using this command:
- *     ip link set interface netns pidInNs
+ *     ip link set @iface netns @pidInNs
  *
  * Returns 0 on success or -1 in case of error
  */