]> git.ipfire.org Git - thirdparty/lxc.git/commitdiff
cleanup: lxc_container::want_* comment descriptions
authorWolfgang Bumiller <w.bumiller@proxmox.com>
Thu, 14 Jan 2016 13:30:20 +0000 (14:30 +0100)
committerStéphane Graber <stgraber@ubuntu.com>
Thu, 28 Jan 2016 10:58:57 +0000 (11:58 +0100)
They change a value and return true on success rather than
fetching the value as the comments previously suggested.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
Acked-by: Serge E. Hallyn <serge.hallyn@ubuntu.com>
src/lxc/lxccontainer.h

index 6d155a14d38ff966b0d706df3ee9b43a9a510ae6..07559019a5d70caf7e867ccde8192e88530e9974 100644 (file)
@@ -222,25 +222,24 @@ struct lxc_container {
        bool (*stop)(struct lxc_container *c);
 
        /*!
-        * \brief Determine if the container wants to run disconnected
+        * \brief Change whether the container wants to run disconnected
         * from the terminal.
         *
         * \param c Container.
         * \param state Value for the daemonize bit (0 or 1).
         *
-        * \return \c true if container wants to be daemonised, else \c false.
+        * \return \c true on success, else \c false.
         */
        bool (*want_daemonize)(struct lxc_container *c, bool state);
 
        /*!
-        * \brief Determine whether container wishes all file descriptors
+        * \brief Change whether the container wishes all file descriptors
         *  to be closed on startup.
         *
         * \param c Container.
         * \param state Value for the close_all_fds bit (0 or 1).
         *
-        * \return \c true if container wants all file descriptors closed,
-        *  else \c false.
+        * \return \c true on success, else \c false.
         */
        bool (*want_close_all_fds)(struct lxc_container *c, bool state);