> -----Original Message----- > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Richardson, Bruce > Sent: Wednesday, June 17, 2015 12:07 PM > To: Neil Horman; Thomas Monjalon > Cc: dev at dpdk.org > Subject: Re: [dpdk-dev] [dpdk-announce] important design choices - > statistics - ABI > Hi Neil, > > on my end, some suggestions: > > 1. the documentation on changing an API function provided in rte_compat.h > is really good, but I don't think this is present in our documentation in > the docs folder or on website is it (apologies if it is and I've missed > it)? This needs to go into programmers guide or some other doc (perhaps > the new doc that the coding style went into). > > 2. The documentation also needs an example of: this is how you add a new > function and update the map file, and this is how you a) mark a function > as deprecated and b) remove it completely. That way we could have one > guide covering API versioning, how to add, modify and remove functions. > > 3. This doc should also cover how to use the API checker tool, something I > haven't had the chance to look at yet, but should do in the near future! > :-)
+1 on all three. We need better documentation on how to work with the ABI in DPDK. A new document in doc/guides/guidelines/ would be good. John
