From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Mcnamara, John" Subject: Re: [dpdk-announce] important design choices - statistics - ABI Date: Fri, 19 Jun 2015 11:08:04 +0000 Message-ID: References: <9092314.MoyqUJ5VU2@xps13> <20150617103521.GB24677@hmsreliant.think-freely.org> <59AF69C657FD0841A61C55336867B5B034558F92@IRSMSX103.ger.corp.intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Cc: "dev@dpdk.org" To: "Richardson, Bruce" , Neil Horman , Thomas Monjalon Return-path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id BB1B3C37C for ; Fri, 19 Jun 2015 13:08:11 +0200 (CEST) In-Reply-To: <59AF69C657FD0841A61C55336867B5B034558F92@IRSMSX103.ger.corp.intel.com> Content-Language: en-US List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Richardson, Bruce > Sent: Wednesday, June 17, 2015 12:07 PM > To: Neil Horman; Thomas Monjalon > Cc: dev@dpdk.org > Subject: Re: [dpdk-dev] [dpdk-announce] important design choices - > statistics - ABI > Hi Neil, >=20 > on my end, some suggestions: >=20 > 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). >=20 > 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. >=20 > 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 i= n DPDK. A new document in doc/guides/guidelines/ would be good. John