From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 1D3DDC38C for ; Wed, 24 Jun 2015 13:21:53 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga103.jf.intel.com with ESMTP; 24 Jun 2015 04:21:49 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,671,1427785200"; d="scan'208";a="749499714" Received: from irsmsx152.ger.corp.intel.com ([163.33.192.66]) by fmsmga002.fm.intel.com with ESMTP; 24 Jun 2015 04:21:48 -0700 Received: from irsmsx155.ger.corp.intel.com (163.33.192.3) by IRSMSX152.ger.corp.intel.com (163.33.192.66) with Microsoft SMTP Server (TLS) id 14.3.224.2; Wed, 24 Jun 2015 12:21:47 +0100 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.216]) by irsmsx155.ger.corp.intel.com ([169.254.14.239]) with mapi id 14.03.0224.002; Wed, 24 Jun 2015 12:21:47 +0100 From: "Mcnamara, John" To: Neil Horman , "dev@dpdk.org" Thread-Topic: [PATCH 2/2] ABI: Add some documentation Thread-Index: AQHQreuqghgw+8v5uEmzJ0wraQsT2Z27fzgA Date: Wed, 24 Jun 2015 11:21:46 +0000 Message-ID: References: <1435088014-18973-1-git-send-email-nhorman@tuxdriver.com> <1435088014-18973-2-git-send-email-nhorman@tuxdriver.com> In-Reply-To: <1435088014-18973-2-git-send-email-nhorman@tuxdriver.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH 2/2] ABI: Add some documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 24 Jun 2015 11:21:54 -0000 > -----Original Message----- > From: Neil Horman [mailto:nhorman@tuxdriver.com] > Sent: Tuesday, June 23, 2015 8:34 PM > To: dev@dpdk.org > Cc: Neil Horman; Mcnamara, John; thomas.monjalon@6wind.com > Subject: [PATCH 2/2] ABI: Add some documentation >=20 > People have been asking for ways to use the ABI macros, heres some docs t= o > clarify their use. Included is: Hi, Thanks for this. There are a few minor comments on the RST structure below. Also, there is a conflict in the doc/guides/guidelines/index.rst file with = an addition that just got merged. I just needs a rebase. > +This file needs to be modified as follows > + > +.. code-block:: none > + > + DPDK_2.0 { > + global: > + > + rte_acl_add_rules; > + rte_acl_build; > + rte_acl_classify; > + rte_acl_classify_alg; > + rte_acl_classify_scalar; > + rte_acl_create; > + rte_acl_dump; > + rte_acl_find_existing; > + rte_acl_free; > + rte_acl_ipv4vlan_add_rules; > + rte_acl_ipv4vlan_build; > + rte_acl_list_dump; > + rte_acl_reset; > + rte_acl_reset_rules; > + rte_acl_set_ctx_classify; > + > + local: *; > + }; > + > + DPDK_2.1 { > + global: > + rte_acl_create; > + > + } DPDK_2.0; The last 7 lines of this verbatim section should be indented to the same le= vel as the rest of the section. In general the code blocks should be indent= ed at least 3 spaces to keep the various RST converters happy. That applies= in a few places. > +Note that the base name of the symbol was kept in tact, as this is > +condusive to the macros used for versioning symbols. That is our next > +step, mapping this new symbol name to the initial symbol name at > +version node 2.0. Immediately after the function, we add this line of > +code > + > +.. code-block:: c > + > + VERSION_SYMBOL(rte_acl_create, _v20, 2.0);VERSION_SYMBOL(rte_acl_crea= te, _v20, 2.0); The is a duplicate macro here. > + > +Remembering to also add the rte_compat.h header to the requisite c file > +where these changes are being made. The above macro instructs the > +linker to create a new symbol rte_acl_create@DPDK_2.0, which matches Could you enclose the symbol in RST backquotes ``rte_acl_create@DPDK_2.0`` = since some of the renderers treat this as an email address! There is anothe= r one a few paragraphs down. > +the symbol created in older builds, but now points to the above newly > +named function. We have now mapped the origional rte_acl_create symbol > +to the origional function=20 There are a few minor typos here and there. > + }; > + > + DPDK_2.1 { > + global: > + rte_acl_create; > + } DPDK_2.0; Same comment as above on indentation. John. --=20