netdev - Re: [net] net: update net_dim documentation after rename

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20191009115759.04196ba2@cakuba.netronome.com>
Date:   Wed, 9 Oct 2019 11:57:59 -0700
From:   Jakub Kicinski <jakub.kicinski@...ronome.com>
To:     Jacob Keller <jacob.e.keller@...el.com>
Cc:     netdev@...r.kernel.org
Subject: Re: [net] net: update net_dim documentation after rename

On Tue,  8 Oct 2019 10:59:41 -0700, Jacob Keller wrote:
> Commit 8960b38932be ("linux/dim: Rename externally used net_dim
> members") renamed the net_dim API, removing the "net_" prefix from the
> structures and functions. The patch didn't update the net_dim.txt
> documentation file.
> 
> Fix the documentation so that its examples match the current code.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@...el.com>

For net patches we will need a Fixes tag pointing to the commit which
caused the divergence. Please also make sure to CC the authors and
maintainers so they get a chance to review your patch.

> @@ -132,13 +132,13 @@ usage is not complete but it should make the outline of the usage clear.
>  
>  my_driver.c:
>  
> -#include <linux/net_dim.h>
> +#include <linux/dim.h>
>  
>  /* Callback for net DIM to schedule on a decision to change moderation */
>  void my_driver_do_dim_work(struct work_struct *work)
>  {
> -	/* Get struct net_dim from struct work_struct */
> -	struct net_dim *dim = container_of(work, struct net_dim,
> +	/* Get struct dim from struct work_struct */
> +	struct dim *dim = container_of(work, struct dim,
>  					   work);

nit: looks like you broke the alignment here 

>  	/* Do interrupt moderation related stuff */
>  	...