Re: [PATCH net-next 00/21] treewide: Use consistent api style foraddress testing

From: Joe Perches
Date: Fri Oct 19 2012 - 06:29:27 EST


(trimmed over long cc list from original 00/21 post)

On Fri, 2012-10-19 at 09:04 +0200, Eric Dumazet wrote:
> On Thu, 2012-10-18 at 20:55 -0700, Joe Perches wrote:
> > ethernet, ipv4, and ipv6 address testing uses 3 different api naming styles.
> >
> > ethernet uses: is_<foo>_ether_addr
> > ipv4 uses: ipv4_is_<foo>
> > ipv6 uses: ipv6_addr_<foo>
> >
> > Standardize on the ipv6 style of <prefix>_addr_<type> to reduce
> > the number of styles to remember.
[]
> Yes they are some names discrepancies, thats a big deal.

missing a not maybe?

> And we have alloc_skb() / kfree_skb() / skb_clone()
> Why not skb_alloc() / skb_free() / skb_clone() ?

Not really a similar use case to this renaming, as alloc/free
functions generally start with alloc/free.

These particular functions all refer to address tests.

> Some people actually know current code by name of functions, they dont
> want to change their mind and having to grep include files and git log
> to learn the new names of an old function, especially when traveling and
> using a laptop.
>
> Sure, when we want to use eth_random_addr(), a grep into include files
> to check if its still the right name (old one was random_ether_addr())
> is OK because we dont use this one often.
>
> If you think about it, eth_random_addr() was not the perfect name.

Luckily, that one's only got 46 references.
I don't care for the <type>_<action>_addr vs <type>_addr_<test>
use either. Maybe a set in the name would have been/still be better.

> Think about all the documentation you can find outside of kernel tree,
> RFC and things like that, copy/pasting some linux kernel code.
>
> This kind of changes make our life more difficult, when we have to
> backport patches or rebase code, or even perform some searches to find
> prior issues/discussions.
>
> Life of a kernel developer is not only dealing with latest Linus (or
> -next) tree, and using automatic 'tools'.
>
> Thats a real pain for me at least.

Pity, api consistency has some value.

cheers, Joe

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/