From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <thomas.monjalon@6wind.com>
Received: from mail-wm0-f49.google.com (mail-wm0-f49.google.com [74.125.82.49])
 by dpdk.org (Postfix) with ESMTP id A24D9370
 for <dev@dpdk.org>; Thu, 30 Jun 2016 20:25:27 +0200 (CEST)
Received: by mail-wm0-f49.google.com with SMTP id v199so232244289wmv.0
 for <dev@dpdk.org>; Thu, 30 Jun 2016 11:25:27 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=6wind-com.20150623.gappssmtp.com; s=20150623;
 h=from:to:cc:subject:date:message-id:user-agent:in-reply-to
 :references:mime-version:content-transfer-encoding;
 bh=3Pqpf25OV3udcIDpQfjkQdmJE3X3winfphdz6dVGA+U=;
 b=wTi24lNKYITZb+MsPo/TRnL4jfYR94/zTUPCyitG2c/kEj8QpmnSqAnV+xO6aOriUW
 oPz6Se9X6tcjoJA0kMMXnL6S31NoUBi6EzG025p8bq7Cp3v2hnfYj15DUUmBY+WhBm9z
 wspr5Ua7qm4CoE18nFZLBHbHj9XRSaVN4cDztbFd7U2ugA7eXBbXGs2glHiLIQVUJKvC
 iF47v8PA3eSmh0Bn8i27I1HsXUeOIeqUnNbBS3Cr1MrrD06E3CeKEtUCDfO1sWbdyqqy
 JyZz8/s66Ex0UF3pTM+UsKrb3m+0K7PHeLTdA/JpM3apL1RV1e3aY7xcRmx/tbAWHavN
 SV4Q==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20130820;
 h=x-gm-message-state:from:to:cc:subject:date:message-id:user-agent
 :in-reply-to:references:mime-version:content-transfer-encoding;
 bh=3Pqpf25OV3udcIDpQfjkQdmJE3X3winfphdz6dVGA+U=;
 b=FWL4Aj2+YL0h8BCamHFaComGo2yJWcMHj3zuNsexPf13tNThtRnxTIrcpI3bc9lGRW
 d7pZ65REZksOPA9SmCR+fUWqanHfHaylbaB9cFHp2J6Fup2IPlpI6j6OenA03Ka1e6Ft
 E6/z4+6XtU9jrs8N5gQmYfd8IyI2qo7Y4tGSbzI8DJvXOg8n+zqT7BujbgHKmZJY9jVn
 k5J28HwRHhu/wSLcF5BhpSTeggtiIIX6FHUwB++I7ZaOjrgbH4+nLIH75saC0tCbSn8p
 hfEi2jIScHurcpAFa07ZSNIZKJjX0pO9Ix17ko1YjvLsA/4ZuYo8zW+IPdUvUO+m3XZA
 3qCA==
X-Gm-Message-State: ALyK8tLGoJ6u853oHlqfqvjVU4RtXtTZeb9EEHFuuctdaG5v3y95pHY/U7Ky3W6HDTe0tSWK
X-Received: by 10.28.210.83 with SMTP id j80mr16475737wmg.54.1467311127436;
 Thu, 30 Jun 2016 11:25:27 -0700 (PDT)
Received: from xps13.localnet (184.16.90.92.rev.sfr.net. [92.90.16.184])
 by smtp.gmail.com with ESMTPSA id m125sm10616523wmm.8.2016.06.30.11.25.26
 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Thu, 30 Jun 2016 11:25:26 -0700 (PDT)
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Date: Thu, 30 Jun 2016 20:25:14 +0200
Message-ID: <1604656.XReoQ6n0NJ@xps13>
User-Agent: KMail/4.14.10 (Linux/4.5.4-1-ARCH; KDE/4.14.11; x86_64; ; )
In-Reply-To: <1467309817-11739-1-git-send-email-john.mcnamara@intel.com>
References: <1467309817-11739-1-git-send-email-john.mcnamara@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
Subject: Re: [dpdk-dev] [PATCH v1] doc: autogenerate nic overview table from
	ini files
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 30 Jun 2016 18:25:27 -0000

2016-06-30 19:03, John McNamara:
> This patch converts the NIC feature table in the overview doc into a set of
> ini files and adds some functions into the Sphinx conf.py file to convert them
> back into an RST table.
> 
> The reason for doing this is to make it easier for PMD maintainers to update
> the feature matrix that makes up the table and to avoid frequent and hard to
> resolve conflicts in doc/guides/nics/overview.rst.

Great idea!

Would it be possible to make it a bit more generic and reusable to
generate other tables of this kind?

> * In order to avoid the merge conflict issue noted above the RST table is now
>   in an external RST include file and excluded from the repo via .gitignore.

It would be better to generate the rst file in the build directory.
But I guess it makes sphinx build more difficult.

> * Blank entries in the PMD ini files are optional. They will get a default
>   blank entry in the RST table based on the entries in the default.ini file.
>   The ini files in this patch were generated programmatically from the
>   original RST table.

I don't think there is a benefit to have blank entries in the .ini file.
And there would be less conflicts if the guideline was to avoid blank entries
when adding a new feature.
> 
> * I would like to extend this to produce a pure Html table with rotated column
>   headers like this: https://css-tricks.com/rotated-table-column-headers/
>   I tried to get this to work within the current RST + CSS preamble but
>   failed.

Nice

> * I would also like to extend this to produce a table, or more likely a number
>   of tables, that would display the same information in the PDF document
>   without going off the page.

PDF output is restrictive :)