From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 793E1A0096 for <public@inbox.dpdk.org>; Wed, 5 Jun 2019 12:39:43 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 28B501B9F4; Wed, 5 Jun 2019 12:39:43 +0200 (CEST) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id C0DD71B9F1 for <dev@dpdk.org>; Wed, 5 Jun 2019 12:39:41 +0200 (CEST) X-Amp-Result: UNSCANNABLE X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 05 Jun 2019 03:39:40 -0700 X-ExtLoop1: 1 Received: from bricha3-mobl.ger.corp.intel.com ([10.237.221.51]) by fmsmga005.fm.intel.com with SMTP; 05 Jun 2019 03:39:38 -0700 Received: by (sSMTP sendmail emulation); Wed, 05 Jun 2019 11:39:38 +0100 Date: Wed, 5 Jun 2019 11:39:37 +0100 From: Bruce Richardson <bruce.richardson@intel.com> To: Thomas Monjalon <thomas@monjalon.net> Cc: bluca@debian.org, dev@dpdk.org Message-ID: <20190605103937.GB1550@bricha3-MOBL.ger.corp.intel.com> References: <15005345.pJipbXyxuh@xps> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <15005345.pJipbXyxuh@xps> User-Agent: Mutt/1.11.4 (2019-03-13) Subject: Re: [dpdk-dev] meson reference guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> On Wed, Jun 05, 2019 at 12:27:34PM +0200, Thomas Monjalon wrote: > Hi, > > For the make build system, we have doc/build-sdk-quick.txt > which is very short and displayed with "make help" for a quick reference. > > For meson, we have doc/build-sdk-meson.txt which is in reality > a full guide formatted in rst. > Should it be moved in Sphinx guides? Probably. > Do we want a really short guide for the basic commands, including > runnning the tests or build the doc? with other basic tooling? > Yes for a short guide, but not sure I'd include tests and building docs in it. I'd suggest just starting with the first section alone of the existing doc. For further docs, links to the online documentation on dpdk.org should suffice rather than needing instructions on building the docs locally. /Bruce