diff mbox series

[net-next,2/2] docs: update ppp_generic.rst to document new ioctls

Message ID 20201126122426.25243-3-tparkin@katalix.com
State New
Headers show
Series add ppp_generic ioctl(s) to bridge channels | expand

Commit Message

Tom Parkin Nov. 26, 2020, 12:24 p.m. UTC 
Add documentation of the newly-added PPPIOCBRIDGECHAN and
PPPIOCUNBRIDGECHAN ioctls.

Signed-off-by: Tom Parkin <tparkin@katalix.com>
---
 Documentation/networking/ppp_generic.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/networking/ppp_generic.rst b/Documentation/networking/ppp_generic.rst
index e60504377900..be25f48468a6 100644
--- a/Documentation/networking/ppp_generic.rst
+++ b/Documentation/networking/ppp_generic.rst
@@ -314,6 +314,15 @@  channel are:
   it is connected to.  It will return an EINVAL error if the channel
   is not connected to an interface.
 
+* PPPIOCBRIDGECHAN bridges a channel with another.  Once two channels
+  are bridged, frames presented to one channel by ppp_input() are passed
+  to the bridge instance for onward transmission.  This allows frames
+  to be switched from one channel into another: for example, to pass
+  PPPoE frames into a PPPoL2TP session.
+
+* PPPIOCUNBRIDGECHAN performs the inverse of PPPIOCBRIDGECHAN, unbridging
+  a channel pair.
+
 * All other ioctl commands are passed to the channel ioctl() function.
 
 The ioctl calls that are available on an instance that is attached to