From: Wolfgang Bumiller Date: Thu, 14 Jan 2016 13:30:20 +0000 (+0100) Subject: cleanup: lxc_container::want_* comment descriptions X-Git-Tag: lxc-1.0.9~103 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=778578599dba51644767436a2ae9e4d9106074d2;p=thirdparty%2Flxc.git cleanup: lxc_container::want_* comment descriptions They change a value and return true on success rather than fetching the value as the comments previously suggested. Signed-off-by: Wolfgang Bumiller Acked-by: Serge E. Hallyn --- diff --git a/src/lxc/lxccontainer.h b/src/lxc/lxccontainer.h index a342a398c..a58d3450a 100644 --- a/src/lxc/lxccontainer.h +++ b/src/lxc/lxccontainer.h @@ -220,25 +220,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);