linux/drivers/net/ethernet/ti
Jesse Brandeburg d0ea5cbdc2 drivers/net/ethernet: clean up mis-targeted comments
As part of the W=1 cleanups for ethernet, a million [*] driver
comments had to be cleaned up to get the W=1 compilation to
succeed. This change finally makes the drivers/net/ethernet tree
compile with W=1 set on the command line. NOTE: The kernel uses
kdoc style (see Documentation/process/kernel-doc.rst) when
documenting code, not doxygen or other styles.

After this patch the x86_64 build has no warnings from W=1, however
scripts/kernel-doc says there are 1545 more warnings in source files, that
I need to develop a script to fix in a followup patch.

The errors fixed here are all kdoc of a few classes, with a few outliers:
In file included from drivers/net/ethernet/qlogic/netxen/netxen_nic_hw.c:10:
drivers/net/ethernet/qlogic/netxen/netxen_nic.h:1193:18: warning: ‘FW_DUMP_LEVELS’ defined but not used [-Wunused-const-variable=]
 1193 | static const u32 FW_DUMP_LEVELS[] = { 0x3, 0x7, 0xf, 0x1f, 0x3f, 0x7f, 0xff };
      |                  ^~~~~~~~~~~~~~
... repeats 4 times...
drivers/net/ethernet/sun/cassini.c:2084:24: warning: suggest braces around empty body in an ‘else’ statement [-Wempty-body]
 2084 |    RX_USED_ADD(page, i);
drivers/net/ethernet/natsemi/ns83820.c: In function ‘phy_intr’:
drivers/net/ethernet/natsemi/ns83820.c:603:6: warning: variable ‘tbisr’ set but not used [-Wunused-but-set-variable]
  603 |  u32 tbisr, tanar, tanlpar;
      |      ^~~~~
drivers/net/ethernet/natsemi/ns83820.c: In function ‘ns83820_get_link_ksettings’:
drivers/net/ethernet/natsemi/ns83820.c:1207:11: warning: variable ‘tanar’ set but not used [-Wunused-but-set-variable]
 1207 |  u32 cfg, tanar, tbicr;
      |           ^~~~~
drivers/net/ethernet/packetengines/yellowfin.c:1063:18: warning: variable ‘yf_size’ set but not used [-Wunused-but-set-variable]
 1063 |   int data_size, yf_size;
      |                  ^~~~~~~

Normal kdoc fixes:
warning: Function parameter or member 'x' not described in 'y'
warning: Excess function parameter 'x' description in 'y'
warning: Cannot understand <string> on line <NNN> - I thought it was a doc line

[*] - ok it wasn't quite a million, but it felt like it.

Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2020-09-25 16:29:00 -07:00
..
am65-cpsw-ethtool.c net: ethernet: ti: ale: add cpsw_ale_get_num_entries api 2020-09-11 17:34:39 -07:00
am65-cpsw-nuss.c net: ethernet: ti: am65-cpsw: enable hw auto ageing 2020-09-11 17:34:39 -07:00
am65-cpsw-nuss.h net: ethernet: ti: am65-cpsw: enable hw auto ageing 2020-09-11 17:34:39 -07:00
am65-cpsw-qos.c ethernet: ti: am65-cpsw-qos: Use struct_size() in devm_kzalloc() 2020-06-19 13:42:08 -07:00
am65-cpsw-qos.h
am65-cpts.c net: ethernet: ti: am65-cpts: fix i2083 genf (and estf) Reconfiguration Issue 2020-08-31 12:29:52 -07:00
am65-cpts.h
cpmac.c
cpsw_ale.c net: ethernet: ti: ale: add support for multi port k3 cpsw versions 2020-09-11 17:34:39 -07:00
cpsw_ale.h net: ethernet: ti: ale: switch to use tables for vlan entry description 2020-09-11 17:34:39 -07:00
cpsw_ethtool.c net: ethernet: ti: ale: add cpsw_ale_get_num_entries api 2020-09-11 17:34:39 -07:00
cpsw_new.c drivers/net/ethernet: clean up unused assignments 2020-09-25 16:29:00 -07:00
cpsw_priv.c net: ethernet: ti: cpsw: use dev_id for ale configuration 2020-09-11 17:34:39 -07:00
cpsw_priv.h net: ethernet: ti: cpsw: use dev_id for ale configuration 2020-09-11 17:34:39 -07:00
cpsw_sl.c
cpsw_sl.h
cpsw_switchdev.c
cpsw_switchdev.h
cpsw-common.c
cpsw-phy-sel.c treewide: Use fallthrough pseudo-keyword 2020-08-23 17:36:59 -05:00
cpsw.c net: ethernet: ti: cpsw: use true,false for bool variables 2020-09-19 14:23:14 -07:00
cpsw.h
cpts.c ethernet: ti: cpts: Use generic helper function 2020-08-19 16:09:19 -07:00
cpts.h
davinci_cpdma.c drivers/net/ethernet: clean up mis-targeted comments 2020-09-25 16:29:00 -07:00
davinci_cpdma.h
davinci_emac.c drivers/net/ethernet: clean up mis-targeted comments 2020-09-25 16:29:00 -07:00
davinci_mdio.c
k3-cppi-desc-pool.c
k3-cppi-desc-pool.h
Kconfig docs: networking: reorganize driver documentation again 2020-06-26 16:08:44 -07:00
Makefile
netcp_core.c
netcp_ethss.c net: netcp: ethss: use dev_id for ale configuration 2020-09-11 17:34:39 -07:00
netcp_sgmii.c
netcp_xgbepcsr.c
netcp.h
tlan.c drivers/net/ethernet: clean up unused assignments 2020-09-25 16:29:00 -07:00
tlan.h