On Sat, 1 Jul 2017 10:26:50 -0600, Jonathan Corbet wrote:
> On Sat, 1 Jul 2017 17:42:46 +0200
> Markus Heiser <markus.heiser@xxxxxxxxxxx> wrote:
>
> > did you have an example for me, where it takes effect? / Thanks!
> >
> > I run kernel-doc against the whole tree, but I can't find any change
> > in the generated reST and I have a doubt for what DECLARE_BITMAP is
> > worth.
>
> That was my question as well...as Andrew would ask: what are the
> user-visible effects of this problem?
The commit which made me write the patch is sitting in Dave Miller's
net-next tree:
43f84b72c50d ("nfp: add metadata to each flow offload")
This is the structure definition:
/**
* struct nfp_flower_priv - Flower APP per-vNIC priv data
* @nn: Pointer to vNIC
* @mask_id_seed: Seed used for mask hash table
* @flower_version: HW version of flower
* @mask_ids: List of free mask ids
* @mask_table: Hash table used to store masks
* @flow_table: Hash table used to store flower rules
*/
struct nfp_flower_priv {
struct nfp_net *nn;
u32 mask_id_seed;
u64 flower_version;
struct nfp_fl_mask_id mask_ids;
DECLARE_HASHTABLE(mask_table, NFP_FLOWER_MASK_HASH_BITS);
DECLARE_HASHTABLE(flow_table, NFP_FLOWER_HASH_BITS);
};
Without this patch to kernel-doc I get:
$ ./scripts/kernel-doc -man drivers/net/ethernet/netronome/nfp/flower/main.h > /dev/null
drivers/net/ethernet/netronome/nfp/flower/main.h:90: warning: No description found for parameter 'NFP_FLOWER_MASK_HASH_BITS'
drivers/net/ethernet/netronome/nfp/flower/main.h:90: warning: No description found for parameter 'NFP_FLOWER_HASH_BITS'
drivers/net/ethernet/netronome/nfp/flower/main.h:90: warning: Excess struct/union/enum/typedef member 'mask_table' description in 'nfp_flower_priv'
drivers/net/ethernet/netronome/nfp/flower/main.h:90: warning: Excess struct/union/enum/typedef member 'flow_table' description in 'nfp_flower_priv'
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
