| Message ID | 20190227195914.4594-1-stefan@datenfreihafen.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | doc: net: ieee802154: move from plain text to rst | expand |
On Wed, 27 Feb 2019 20:59:12 +0100 Stefan Schmidt <stefan@datenfreihafen.org> wrote: > The patches are based on net-next, but they only touch the networking book so I > would not expect and trouble. From what I have seen they would go through > Jonathan's tree after being acked by Dave? If you want this patches against a > different tree let me know. Usually Dave takes networking documentation patches directly, so that is what I would expect here. I took a quick look anyway; seems generally good. The main comment I would make is that much of what's there would be better placed as kerneldoc comments in the code itself that can then be pulled into the formatted docs. But that can be a job for another day... Thanks, jon
Hello Jon. On 27.02.19 21:18, Jonathan Corbet wrote: > On Wed, 27 Feb 2019 20:59:12 +0100 > Stefan Schmidt <stefan@datenfreihafen.org> wrote: > >> The patches are based on net-next, but they only touch the networking book so I >> would not expect and trouble. From what I have seen they would go through >> Jonathan's tree after being acked by Dave? If you want this patches against a >> different tree let me know. > > Usually Dave takes networking documentation patches directly, so that is > what I would expect here. OK, so I got that wrong. Works for me. Dave, you want to take them directly, if nothing else comes up during review, or should I apply them to my tree and send them with the next pull request? > I took a quick look anyway; seems generally good. The main comment I > would make is that much of what's there would be better placed as > kerneldoc comments in the code itself that can then be pulled into the > formatted docs. But that can be a job for another day... Interesting point. That might be indeed a good idea on some parts of this sparse doc. Need to check how this is handled in other docs. It also needs extending scope and context, but again something for a follow up patchset. regards Stefan Schmidt
From: Stefan Schmidt <stefan@datenfreihafen.org> Date: Wed, 27 Feb 2019 22:20:58 +0100 > Hello Jon. > > On 27.02.19 21:18, Jonathan Corbet wrote: >> On Wed, 27 Feb 2019 20:59:12 +0100 >> Stefan Schmidt <stefan@datenfreihafen.org> wrote: >> >>> The patches are based on net-next, but they only touch the networking book so I >>> would not expect and trouble. From what I have seen they would go through >>> Jonathan's tree after being acked by Dave? If you want this patches against a >>> different tree let me know. >> >> Usually Dave takes networking documentation patches directly, so that is >> what I would expect here. > > OK, so I got that wrong. Works for me. Dave, you want to take them > directly, if nothing else comes up during review, or should I apply them > to my tree and send them with the next pull request? I'll take them, thanks.
From: Stefan Schmidt <stefan@datenfreihafen.org> Date: Wed, 27 Feb 2019 20:59:12 +0100 > The ieee802154 subsystem doc was still in plain text. With the networking book > taking shape I thought it was time to do the first step and move it over to rst. > This really is only the minimal conversion. I need to take some time to update > and extend the docs. > > The patches are based on net-next, but they only touch the networking book so I > would not expect and trouble. From what I have seen they would go through > Jonathan's tree after being acked by Dave? If you want this patches against a > different tree let me know. Series applied, thanks Stefan.
Hello. The ieee802154 subsystem doc was still in plain text. With the networking book taking shape I thought it was time to do the first step and move it over to rst. This really is only the minimal conversion. I need to take some time to update and extend the docs. The patches are based on net-next, but they only touch the networking book so I would not expect and trouble. From what I have seen they would go through Jonathan's tree after being acked by Dave? If you want this patches against a different tree let me know. regards Stefan Schmidt Stefan Schmidt (2): doc: net: ieee802154: introduce IEEE 802.15.4 subsystem doc in rst style doc: net: ieee802154: remove old plain text docs after switching to rst .../{ieee802154.txt => ieee802154.rst} | 193 +++++++++--------- Documentation/networking/index.rst | 1 + 2 files changed, 99 insertions(+), 95 deletions(-) rename Documentation/networking/{ieee802154.txt => ieee802154.rst} (58%)