]> git.baikalelectronics.ru Git - kernel.git/commitdiff
docs: net: dsa: document the teardown method
authorVladimir Oltean <vladimir.oltean@nxp.com>
Sat, 16 Jul 2022 18:53:35 +0000 (21:53 +0300)
committerDavid S. Miller <davem@davemloft.net>
Mon, 18 Jul 2022 11:44:37 +0000 (12:44 +0100)
A teardown method was added to dsa_switch_ops without being documented.
Do so now.

Fixes: 5e3f847a02aa ("net: dsa: Add teardown callback for drivers")
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/dsa/dsa.rst

index 83c1a02376c8a67c3128f04b640c882a80da539d..e16eb2e5e7878ccf4413d89c6bb2ee538bc2be1e 100644 (file)
@@ -617,7 +617,8 @@ Switch configuration
   fully configured and ready to serve any kind of request. It is recommended
   to issue a software reset of the switch during this setup function in order to
   avoid relying on what a previous software agent such as a bootloader/firmware
-  may have previously configured.
+  may have previously configured. The method responsible for undoing any
+  applicable allocations or operations done here is ``teardown``.
 
 PHY devices and link management
 -------------------------------