| Message ID | 20241023041203.35313-1-leocstone@gmail.com (mailing list archive) |
|---|---|
| State | Awaiting Upstream |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net] Documentation: ieee802154: fix grammar | expand |
Hi Leo, leocstone@gmail.com wrote on Tue, 22 Oct 2024 21:12:01 -0700: > Fix grammar where it improves readability. > > Signed-off-by: Leo Stone <leocstone@gmail.com> Reviewed-by: Miquel Raynal <miquel.raynal@bootlin.com> Thanks, Miquèl
On Tue, Oct 22, 2024 at 09:12:01PM -0700, Leo Stone wrote: > Fix grammar where it improves readability. > > Signed-off-by: Leo Stone <leocstone@gmail.com> Reviewed-by: Simon Horman <horms@kernel.org>
On Tue, Oct 22, 2024 at 09:12:01PM -0700, Leo Stone wrote: > diff --git a/Documentation/networking/ieee802154.rst b/Documentation/networking/ieee802154.rst > index c652d383fe10..743c0a80e309 100644 > --- a/Documentation/networking/ieee802154.rst > +++ b/Documentation/networking/ieee802154.rst > @@ -72,7 +72,8 @@ exports a management (e.g. MLME) and data API. > possibly with some kinds of acceleration like automatic CRC computation and > comparison, automagic ACK handling, address matching, etc. > > -Those types of devices require different approach to be hooked into Linux kernel. > +Each type of device requires a different approach to be hooked into the Linux > +kernel. > > HardMAC > ------- > @@ -81,10 +82,10 @@ See the header include/net/ieee802154_netdev.h. You have to implement Linux > net_device, with .type = ARPHRD_IEEE802154. Data is exchanged with socket family > code via plain sk_buffs. On skb reception skb->cb must contain additional > info as described in the struct ieee802154_mac_cb. During packet transmission > -the skb->cb is used to provide additional data to device's header_ops->create > -function. Be aware that this data can be overridden later (when socket code > -submits skb to qdisc), so if you need something from that cb later, you should > -store info in the skb->data on your own. > +the skb->cb is used to provide additional data to the device's > +header_ops->create function. Be aware that this data can be overridden later > +(when socket code submits skb to qdisc), so if you need something from that cb > +later, you should store info in the skb->data on your own. > > To hook the MLME interface you have to populate the ml_priv field of your > net_device with a pointer to struct ieee802154_mlme_ops instance. The fields > @@ -94,8 +95,9 @@ All other fields are required. > SoftMAC > ------- > > -The MAC is the middle layer in the IEEE 802.15.4 Linux stack. This moment it > -provides interface for drivers registration and management of slave interfaces. > +The MAC is the middle layer in the IEEE 802.15.4 Linux stack. At the moment, it > +provides an interface for driver registration and management of slave > +interfaces. > > NOTE: Currently the only monitor device type is supported - it's IEEE 802.15.4 > stack interface for network sniffers (e.g. WireShark). Looks good, thanks! Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Hello Leo Stone. On Tue, 22 Oct 2024 21:12:01 -0700, Leo Stone wrote: > Fix grammar where it improves readability. > > Applied to wpan/wpan-next.git, thanks! [1/1] Documentation: ieee802154: fix grammar https://git.kernel.org/wpan/wpan-next/c/2107395f0711 regards, Stefan Schmidt
diff --git a/Documentation/networking/ieee802154.rst b/Documentation/networking/ieee802154.rst index c652d383fe10..743c0a80e309 100644 --- a/Documentation/networking/ieee802154.rst +++ b/Documentation/networking/ieee802154.rst @@ -72,7 +72,8 @@ exports a management (e.g. MLME) and data API. possibly with some kinds of acceleration like automatic CRC computation and comparison, automagic ACK handling, address matching, etc. -Those types of devices require different approach to be hooked into Linux kernel. +Each type of device requires a different approach to be hooked into the Linux +kernel. HardMAC ------- @@ -81,10 +82,10 @@ See the header include/net/ieee802154_netdev.h. You have to implement Linux net_device, with .type = ARPHRD_IEEE802154. Data is exchanged with socket family code via plain sk_buffs. On skb reception skb->cb must contain additional info as described in the struct ieee802154_mac_cb. During packet transmission -the skb->cb is used to provide additional data to device's header_ops->create -function. Be aware that this data can be overridden later (when socket code -submits skb to qdisc), so if you need something from that cb later, you should -store info in the skb->data on your own. +the skb->cb is used to provide additional data to the device's +header_ops->create function. Be aware that this data can be overridden later +(when socket code submits skb to qdisc), so if you need something from that cb +later, you should store info in the skb->data on your own. To hook the MLME interface you have to populate the ml_priv field of your net_device with a pointer to struct ieee802154_mlme_ops instance. The fields @@ -94,8 +95,9 @@ All other fields are required. SoftMAC ------- -The MAC is the middle layer in the IEEE 802.15.4 Linux stack. This moment it -provides interface for drivers registration and management of slave interfaces. +The MAC is the middle layer in the IEEE 802.15.4 Linux stack. At the moment, it +provides an interface for driver registration and management of slave +interfaces. NOTE: Currently the only monitor device type is supported - it's IEEE 802.15.4 stack interface for network sniffers (e.g. WireShark).
Fix grammar where it improves readability. Signed-off-by: Leo Stone <leocstone@gmail.com> --- Documentation/networking/ieee802154.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)