[lxc-devel] [RFC 2/2] cleanup: lxc_container::want_* comment descriptions

[Serge Hallyn]

Quoting Wolfgang Bumiller (w.bumiller at proxmox.com):
> 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 at proxmox.com>

Yikes, yes the return value description is entirely wrong.

Thanks

Acked-by: Serge E. Hallyn <serge.hallyn at ubuntu.com>

> ---
>  src/lxc/lxccontainer.h | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/src/lxc/lxccontainer.h b/src/lxc/lxccontainer.h
> index 454f029..3ab258e 100644
> --- a/src/lxc/lxccontainer.h
> +++ b/src/lxc/lxccontainer.h
> @@ -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);
>  
> -- 
> 2.1.4
> 
> 
> _______________________________________________
> lxc-devel mailing list
> lxc-devel at lists.linuxcontainers.org
> http://lists.linuxcontainers.org/listinfo/lxc-devel