Re: [PATCH 1/2] Several minor fixes for documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Apr 25, 2013 at 12:54 AM, Yang Chengwei <chengwei.yang@xxxxxxxxx> wrote:
> On Thu, Apr 25, 2013 at 12:34:11AM -0300, Lucas De Marchi wrote:
>> Hi Chengwei
>>
>> On Wed, Apr 24, 2013 at 5:19 AM, Chengwei Yang <chengwei.yang@xxxxxxxxx> wrote:
>> > Signed-off-by: Chengwei Yang <chengwei.yang@xxxxxxxxx>
>>
>> First of all, we don't use s-o-b in kmod. Please remember this for the
>> next patches
>
> Sure.
>
>>
>>
>> > ---
>> >  libkmod/libkmod-module.c |   10 ++++------
>> >  libkmod/libkmod.c        |    6 ++++--
>> >  2 files changed, 8 insertions(+), 8 deletions(-)
>> >
>> > diff --git a/libkmod/libkmod-module.c b/libkmod/libkmod-module.c
>> > index 47d12ad..4754eeb 100644
>> > --- a/libkmod/libkmod-module.c
>> > +++ b/libkmod/libkmod-module.c
>> > @@ -570,8 +570,7 @@ fail:
>> >   * Drop a reference of each kmod module in @list and releases the resources
>> >   * taken by the list itself.
>> >   *
>> > - * Returns: NULL if @mod is NULL or if the module was released. Otherwise it
>> > - * returns the passed @mod with its refcount decremented.
>> > + * Returns: 0
>> >   */
>>
>> good catch.
>
> Thanks.
>
>>
>> >  KMOD_EXPORT int kmod_module_unref_list(struct kmod_list *list)
>> >  {
>> > @@ -629,9 +628,8 @@ static const struct kmod_list *module_get_dependencies_noref(const struct kmod_m
>> >   * The result is cached in @mod, so subsequent calls to this function will
>> >   * return the already searched list of modules.
>> >   *
>> > - * Returns: NULL on failure or if there are any dependencies. Otherwise it
>> > - * returns a list of kmod modules that can be released by calling
>> > - * kmod_module_unref_list().
>> > + * Returns: NULL on failure. Otherwise it returns a list of kmod modules
>>
>> Actually what was wrong was the use of "any". Returning NULL is not
>> necessarily a failure. Yes, it was a mistake doing a return like this
>> :(
>>
>> > + * that can be released by calling kmod_module_unref_list().
>> >   */
>> >  KMOD_EXPORT struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod)
>> >  {
>> > @@ -1564,7 +1562,7 @@ void kmod_module_set_remove_commands(struct kmod_module *mod, const char *cmd)
>> >   * Create a new list of kmod modules with all modules currently loaded in
>> >   * kernel. It uses /proc/modules to get the names of loaded modules and to
>> >   * create kmod modules by calling kmod_module_new_from_name() in each of them.
>> > - * They are put are put in @list in no particular order.
>> > + * They are put in @list in no particular order.
>> >   *
>> >   * The initial refcount is 1, and needs to be decremented to release the
>> >   * resources of the kmod_module. The returned @list must be released by
>> > diff --git a/libkmod/libkmod.c b/libkmod/libkmod.c
>> > index 66d4859..1113614 100644
>> > --- a/libkmod/libkmod.c
>> > +++ b/libkmod/libkmod.c
>> > @@ -219,8 +219,8 @@ static char *get_kernel_release(const char *dirname)
>> >   * kmod_new:
>> >   * @dirname: what to consider as linux module's directory, if NULL
>> >   *           defaults to /lib/modules/`uname -r`. If it's relative,
>> > - *           it's treated as relative to current the current working
>> > - *           directory. Otherwise, give an absolute dirname.
>> > + *           it's treated as relative to the current working directory.
>> > + *           Otherwise, give an absolute dirname.
>> >   * @config_paths: ordered array of paths (directories or files) where
>> >   *                to load from user-defined configuration parameters such as
>> >   *                alias, blacklists, commands (install, remove). If
>> > @@ -307,6 +307,8 @@ KMOD_EXPORT struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx)
>> >   *
>> >   * Drop a reference of the kmod library context. If the refcount
>> >   * reaches zero, the resources of the context will be released.
>> > + *
>> > + * Returns: the passed kmod library context
>>
>> or NULL if it's freed.
>
> Yes, I just found that there are several places don't clarify NULL will
> returned, so I follow the rule. :-). E.g. kmod_new, kmod_unref...
>
> Would you like me to upload a V2 or just keep it as it?

take a look on the other comments, also in the other patch and then submit a v2.

thanks
Lucas De Marchi
--
To unsubscribe from this list: send the line "unsubscribe linux-modules" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux