From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <thomas.monjalon@6wind.com>
Received: from mail-wm0-f47.google.com (mail-wm0-f47.google.com [74.125.82.47])
 by dpdk.org (Postfix) with ESMTP id 3109829D6
 for <dev@dpdk.org>; Wed,  2 Mar 2016 23:17:34 +0100 (CET)
Received: by mail-wm0-f47.google.com with SMTP id p65so9137112wmp.1
 for <dev@dpdk.org>; Wed, 02 Mar 2016 14:17:34 -0800 (PST)
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:organization:user-agent
 :in-reply-to:references:mime-version:content-transfer-encoding;
 bh=Z7RzjCJGRws7O/XVEZ/vNpoFLneIKmaoMmZL2bJ2D0k=;
 b=hc8cMVI8GVn9TUVAZ2369Cf0Fi5oe83q31rOVTOPzl7+Dssuo4Dxmdrh6bYk9lAc1u
 SaViCNE1FhNlKtqM2++SbBxvKLS6cD216Z18ZtFZumLmOWVJ8HnXPAXQhD8o1ruBKwUe
 M2RR+pUpdldeLCo+inVpkmLICt+Yx8PkGodfjEbgLurxGvWnszVlypYH9KtOGYhgP9So
 MohDUWLtpLZtaqA98+7G6tNEup77YozM4MTD/lV0JfGH/vIll0gsjKzkoIjXlTJq1AMi
 FT/TVftx2of59Sv3jgStSJiwIpnOQJJrrDEcH+YQ/TfqiurA9evuLEgxt64/0YbJ6aGx
 x7yQ==
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:organization
 :user-agent:in-reply-to:references:mime-version
 :content-transfer-encoding;
 bh=Z7RzjCJGRws7O/XVEZ/vNpoFLneIKmaoMmZL2bJ2D0k=;
 b=ZNjoPP8C3261LXF4LTLayQPOqG+CkaboxI4H8xbbxUdvwUMk1cI74ySOZY2o9VlNe3
 1nQThOsg1lNlbZxvXqandUmt/LB2t0bIhELzQ6tW8iMc3Lx742+i0lzDODP5Q1+gpCps
 JLtL5jhRZJcy5ukhXIPn+zNAWkjWAQqMZya6hemq/ABVcIT6MMtWywVhvi8CA2p1g8nF
 hx5hADA2u9cmvHg6vL9UXe3PlFUukPu3B7vuBc6zoCYzKxdq3cU6/YyVUsf1aqzfJr17
 JSvOmLp8TL+1eTHNMy8sROMBmmPS1VFhv1liLGE32sARlmb4sAqvkPUn4zPtMf7NnlQ/
 UOrA==
X-Gm-Message-State: AD7BkJID7IPcPZZ/SwQDD2O+u8Ckv8S6va56PD2xQVMDQkdyVWZUlN+vYJ8NX+qYWrds9SiJ
X-Received: by 10.194.216.2 with SMTP id om2mr27824184wjc.164.1456957054061;
 Wed, 02 Mar 2016 14:17:34 -0800 (PST)
Received: from xps13.localnet ([93.158.56.12])
 by smtp.gmail.com with ESMTPSA id ei9sm37933598wjd.40.2016.03.02.14.17.33
 (version=TLSv1/SSLv3 cipher=OTHER);
 Wed, 02 Mar 2016 14:17:33 -0800 (PST)
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: Stephen Hurd <stephen.hurd@broadcom.com>
Date: Wed, 02 Mar 2016 23:15:58 +0100
Message-ID: <3156888.xIWalfADA6@xps13>
Organization: 6WIND
User-Agent: KMail/4.14.10 (Linux/4.1.6-1-ARCH; KDE/4.14.11; x86_64; ; )
In-Reply-To: <CAJ9nmBbvmmO_ajjqCSjGnRMGVd_GDB_MGwUcSKeRYsgg7cheng@mail.gmail.com>
References: <CAJ9nmBaWh8WsuzQcAfrebjaFNYSGsGxEd5Y5DQfWTPuxYY8XWQ@mail.gmail.com>
 <1915798.D06pWLxedU@xps13>
 <CAJ9nmBbvmmO_ajjqCSjGnRMGVd_GDB_MGwUcSKeRYsgg7cheng@mail.gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] New driver (large patch) question.
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: Wed, 02 Mar 2016 22:17:34 -0000

2016-03-02 14:06, Stephen Hurd:
> The issue is that the big header in question is the whole hardware/firmware
> interface definition.  The comments in it are the only publicly available
> documentation on the hardware I'm aware of.

So you must keep the comments.

> The driver itself doesn't have a lot of optional features in it, it's the
> header file that's too big.

It is big because there are many different things.
You can split the file in different patches.
Examples:
	- a patch for RSS will bring the hardware structures for RSS
	- a patch for the stats will bring the hardware stats structures
	etc

PS: please answer inline

 
> On Wed, Mar 2, 2016 at 1:54 PM, Thomas Monjalon <thomas.monjalon@6wind.com>
> wrote:
> 
> > 2016-03-02 13:30, Stephen Hurd:
> > > The bulk of the patch is the hardware interface header file.  With all
> > the
> > > comments, it weighs in around 800k.  If I strip the comments, it's around
> > > 300k.  If I both strip all the comments and remove all the currently
> > unused
> > > structures, I can get the entire patch down just below 300k, but that
> > makes
> > > it much harder for someone to do further development.  I'm willing to do
> > > that though if it's what's preferred.
> > >
> > > The other large file (560k) is just a bunch of extra debug output that
> > > makes it easier to debug issues.  It's normally not compiled, so it
> > sounds
> > > like it's not wanted either.
> >
> > If the code is not needed, it's obviously better to not submit it :)
> >
> > > I'll submit without comments in the hardware interface file and take it
> > > from there.
> >
> > I don't think removing the comments is a good option.
> > Please try to split per-feature to make it readable.
> > You can check how fm10k was introduced as an example:
> >         http://thread.gmane.org/gmane.comp.networking.dpdk.devel/13447
> > or mlx5:
> >         http://thread.gmane.org/gmane.comp.networking.dpdk.devel/26986
> >
> 
> 
> 
>