summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorVladimir Oltean <vladimir.oltean@nxp.com>2022-07-16 21:53:35 +0300
committerDavid S. Miller <davem@davemloft.net>2022-07-18 14:44:37 +0300
commitb763f50dc157c2796dded090fac3e05cb5147348 (patch)
tree47181a09f172fc2c8c39271bfc6ed7e96b11f8cc /Documentation
parentd6a0336addd47af8869953a480e44a63726fad8f (diff)
downloadlinux-b763f50dc157c2796dded090fac3e05cb5147348.tar.xz
docs: net: dsa: document the teardown method
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>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/networking/dsa/dsa.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/networking/dsa/dsa.rst b/Documentation/networking/dsa/dsa.rst
index 83c1a02376c8..e16eb2e5e787 100644
--- a/Documentation/networking/dsa/dsa.rst
+++ b/Documentation/networking/dsa/dsa.rst
@@ -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
-------------------------------