On 27/12/2019 18:57, Heinrich Schuchardt wrote:
Hi Heinrich,
On 11/25/19 2:32 AM, Andre Przywara wrote:
doc/README.drivers.eth seems like a good source for understanding U-Boot's network subsystem, but is only talking about legacy network drivers. This is particularly sad as proper documentation would help in porting drivers over to the driver model.
Rewrite the document to describe network drivers in the new driver model world. Most driver callbacks are almost identical in their semantic, but recv() differs in some important details.
Also keep some parts of the original text at the end, to help understanding old drivers. Add some hints on how to port drivers over.
This also uses the opportunity to reformat the document in reST.
Signed-off-by: Andre Przywara andre.przywara@arm.com
doc/README.drivers.eth | 438 ++++++++++++++++++++++++++++++------------------- 1 file changed, 271 insertions(+), 167 deletions(-)
diff --git a/doc/README.drivers.eth b/doc/README.drivers.eth
Now that this file is in restructured text I think we should rename the file with a .rst ending and put it somewhere into the documentation generated by `make htmldocs`. Cf. https://www.xypron.de/u-boot/. Would the driver-model chapter be the appropriate place?
Yeah, I moved it now there, adding it to the index. Also I checked again on the changes to the headings style you suggested earlier, and this now seems to work for me here, so I changed that too.
Thanks! Andre