From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id C1DA2A0471 for ; Thu, 18 Jul 2019 16:59:16 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E84141B53; Thu, 18 Jul 2019 16:59:15 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 46CBADE3 for ; Thu, 18 Jul 2019 16:59:14 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Jul 2019 07:59:13 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,278,1559545200"; d="scan'208";a="251838178" Received: from fmsmsx104.amr.corp.intel.com ([10.18.124.202]) by orsmga001.jf.intel.com with ESMTP; 18 Jul 2019 07:59:12 -0700 Received: from fmsmsx125.amr.corp.intel.com (10.18.125.40) by fmsmsx104.amr.corp.intel.com (10.18.124.202) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 18 Jul 2019 07:59:12 -0700 Received: from FMSMSX109.amr.corp.intel.com ([169.254.15.78]) by FMSMSX125.amr.corp.intel.com ([169.254.2.73]) with mapi id 14.03.0439.000; Thu, 18 Jul 2019 07:59:12 -0700 From: "Chautru, Nicolas" To: Thomas Monjalon CC: "Mcnamara, John" , "Kovacevic, Marko" , "dev@dpdk.org" Thread-Topic: [PATCH] doc: fix PDF build of bbdev prog guide Thread-Index: AQHVPOs6qT8Efj/xxk6glIfbff4p56bQKevQgACwQgD//5yA0A== Date: Thu, 18 Jul 2019 14:59:11 +0000 Message-ID: <1183128033837D43A851F70F33ED5C575C1FD52C@FMSMSX109.amr.corp.intel.com> References: <20190717220123.6165-1-thomas@monjalon.net> <1183128033837D43A851F70F33ED5C575C1FD28B@FMSMSX109.amr.corp.intel.com> <65166682.iuaK6TOrCN@xps> In-Reply-To: <65166682.iuaK6TOrCN@xps> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNWFkNmMyMTEtNjM1MC00NmQwLTgyNGYtMjBjYzczYzJkNDI1IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiY24yZnR6NDluM3dLeG81bjM0MmRObzRnemtrRWkxNVwvVFp2WHAwTDlNVEt3V0N2R0JTdlhLTVI0MHBWSmtcLzArIn0= x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.600.7 dlp-reaction: no-action x-originating-ip: [10.1.200.108] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: Thomas Monjalon [mailto:thomas@monjalon.net]=20 >18/07/2019 15:33, Chautru, Nicolas: >> From: Thomas Monjalon [mailto:thomas@monjalon.net] >> >Anyway all the documentation about the API details should be removed. >> >The guide is expected to give an understanding of the whole design, not= replacing the details maintained in the doxygen comments. >>=20 >> Thanks Thomas.=20 >> These tables are arguably useful on that page with the related contextua= l verbose information aside which provide more context usage. Still I am re= formatting into simpler table structure.=20 >> I have just pushed a parallel patch here :=20 >> https://patches.dpdk.org/patch/56715/ > >Sorry, I am not sure to understand. >You want to keep all this information? I would rather yes. I can see your point with some redundancy between code = and documentation, but the bbdev.rst documentation is arguably clearer as i= t is : the detailed information in paragraphs puts into context some of the= information captured in a nice and concise table. Clearer than having to g= o back and forth in doxygen capturing some of this in a less compact format= (which still has its own complementary value). Matter of opinion, let me k= now if you have a fundamental concern with keeping such table in that docum= ent.=20