DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Mcnamara, John" <john.mcnamara@intel.com>
To: David Marchand <david.marchand@6wind.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 09/11] doc: refresh headers list
Date: Mon, 18 Jan 2016 16:25:26 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE20242A14B@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <CALwxeUuBDOr-qYH19SS1w+Pyh+O4b8AdM7TCzSWocL5EeQ5QSQ@mail.gmail.com>



> -----Original Message-----
> From: David Marchand [mailto:david.marchand@6wind.com]
> Sent: Saturday, January 16, 2016 3:11 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org; Thomas Monjalon
> Subject: Re: [dpdk-dev] [PATCH 09/11] doc: refresh headers list
> 
> Hello John,
> 
> On Tue, Jan 12, 2016 at 3:06 PM, Mcnamara, John <john.mcnamara@intel.com>
> wrote:
> >> -----Original Message-----
> >> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Marchand
> >> Sent: Sunday, January 10, 2016 12:51 PM
> >> To: dev@dpdk.org
> >> Cc: thomas.monjalon@dpdk.org
> >> Subject: [dpdk-dev] [PATCH 09/11] doc: refresh headers list
> >>
> >> Since we are going to remove a header in next commit, let's first
> >> refresh documentation.
> >
> > I don't like these parts of the docs that list files since they go out
> > of date quite easily and, in general, the same information can be
> > conveyed by just listing the directories. (That isn't future-proof
> > either but it should be less subject to change.)
> 
> Well, we could imagine something automatic (in the build process), but I
> agree that the quickest solution is to get rid of it.
> 
> >
> > In this case you could just remove everything in the console section
> > after the output from "ls x86_64-native-linuxapp-gcc" like this:
> >
> >
> > Each build directory contains include files, libraries, and applications
> like the following::
> >
> >     $ ls
> >     app                       tools
> >     config                    MAINTAINERS
> >     Makefile                  GNUmakefile
> >     drivers                   mk
> >     examples                  pkg
> >     doc                       README
> >     lib                       scripts
> >     LICENSE.GPL               LICENSE.LGPL
> >     i686-native-linuxapp-gcc  x86_64-native-linuxapp-gcc
> >     i686-native-linuxapp-icc  x86_64-native-linuxapp-icc
> >
> >     $ ls x86_64-native-linuxapp-gcc
> >     app  build  include  kmod  lib  Makefile
> >
> 
> Well, from my pov, it is the same issue here.
> How about just removing all those files listings ?
> I am not sure they really help.

Hi,

I'm fine with that. I don't think the file listing adds much information to the previous paragraph. 

Or we could just add text that leaves out some of the information
so that the reader doesn’t expect an exact representation and isn't
confused when their file structure doesn't match. Something like:

    $ ls
    ...
    app
    config
    doc
    drivers
    examples
    lib
    ...
    i686-native-linuxapp-gcc  
    i686-native-linuxapp-icc  
    x86_64-native-linuxapp-gcc
    x86_64-native-linuxapp-icc
    ...

John.
-- 


  parent reply	other threads:[~2016-01-18 16:25 UTC|newest]

Thread overview: 92+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-05 19:37 [dpdk-dev] time to kill rte_pci_dev_ids.h Stephen Hemminger
2016-01-06  1:40 ` Thomas Monjalon
2016-01-08 13:20   ` David Marchand
2016-01-10 12:50     ` [dpdk-dev] [PATCH 00/11] kill global pci device id list David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 01/11] e1000: move pci device ids to driver David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 02/11] ixgbe: " David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 03/11] i40e: " David Marchand
2016-01-10 20:02         ` Stephen Hemminger
2016-01-12  8:45           ` David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 04/11] fm10k: " David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 05/11] virtio: " David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 06/11] vmxnet3: " David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 07/11] enic: " David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 08/11] bnx2x: " David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 09/11] doc: refresh headers list David Marchand
2016-01-12 14:06         ` Mcnamara, John
2016-01-16 15:10           ` David Marchand
2016-01-18  9:47             ` Thomas Monjalon
2016-01-18 16:25             ` Mcnamara, John [this message]
2016-01-10 12:50       ` [dpdk-dev] [PATCH 10/11] pci: no need for global device ids list David Marchand
2016-01-10 12:50       ` [dpdk-dev] [PATCH 11/11] pci: place all uio pci device ids in a dedicated section David Marchand
2016-01-10 12:58       ` [dpdk-dev] [PATCH 00/11] kill global pci device id list David Marchand
2016-01-10 13:24         ` Thomas Monjalon
2016-01-10 13:26           ` David Marchand
2016-01-10 13:27             ` David Marchand
2016-01-10 15:53       ` Zhang, Helin
2016-01-16 15:02         ` David Marchand
2016-01-21  1:12           ` Zhang, Helin
2016-01-18 12:30       ` [dpdk-dev] [PATCH v2 00/10] " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 01/10] e1000: move pci device ids to driver David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 02/10] ixgbe: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 03/10] i40e: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 04/10] fm10k: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 05/10] virtio: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 06/10] vmxnet3: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 07/10] enic: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 08/10] bnx2x: " David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 09/10] pci: no need for global device ids list David Marchand
2016-01-18 12:30         ` [dpdk-dev] [PATCH v2 10/10] pci: place all uio pci device ids in a dedicated section David Marchand
2016-01-19  7:30           ` Thomas Monjalon
2016-01-19 14:29             ` Neil Horman
2016-01-19 16:10               ` Stephen Hemminger
2016-01-19 20:56                 ` Neil Horman
2016-01-19 21:35                   ` Stephen Hemminger
2016-01-20 15:40                     ` Neil Horman
2016-02-24 11:37                       ` Bruce Richardson
2016-02-24 11:50                         ` Thomas Monjalon
2016-02-24 14:18                           ` Neil Horman
2016-04-20 12:43         ` [dpdk-dev] [PATCH v3 00/13] kill global pci device id list David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 01/13] e1000: move pci device ids to driver David Marchand
2016-04-20 13:29             ` Neil Horman
2016-04-20 13:39               ` David Marchand
2016-04-20 18:15                 ` Neil Horman
2016-04-21  7:27                   ` David Marchand
2016-04-21 12:08                     ` Neil Horman
2016-04-21 12:41                       ` Thomas Monjalon
2016-04-22 12:13                         ` Neil Horman
2016-04-22 13:22                           ` Thomas Monjalon
2016-07-08 13:31             ` Thomas Monjalon
2016-07-11  5:33               ` Yuanhan Liu
2016-07-11  5:56                 ` Thomas Monjalon
2016-07-11  6:05                   ` Yuanhan Liu
2016-07-11 11:35                   ` David Marchand
2016-07-11 12:05                     ` Yuanhan Liu
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 02/13] ixgbe: " David Marchand
2016-04-29  1:34             ` Wu, Jingjing
2016-05-04  8:26               ` David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 03/13] i40e: " David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 04/13] fm10k: " David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 05/13] virtio: " David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 06/13] vmxnet3: " David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 07/13] enic: " David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 08/13] bnx2x: " David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 09/13] ena: remove unneeded pci macro David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 10/13] pci: no need for global device ids list David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 11/13] drivers: constify pci id tables David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 12/13] drivers: export pci drivers David Marchand
2016-04-20 12:43           ` [dpdk-dev] [PATCH v3 13/13] app: introduce dpdk-obj-info tool David Marchand
2016-04-21  8:07           ` [dpdk-dev] [PATCH v3 00/13] kill global pci device id list David Marchand
2016-04-21 12:13             ` Neil Horman
2016-07-11 14:40           ` [dpdk-dev] [PATCH v4 00/10] kill global pci device id list (almost) David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 01/10] eal: remove PCI device ids header from doxygen David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 02/10] net/e1000: move em PCI device ids to the driver David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 03/10] net/i40e: move " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 04/10] net/fm10k: " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 05/10] net/virtio: " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 06/10] net/vmxnet3: " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 07/10] net/enic: " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 08/10] net/bnx2x: " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 09/10] net/bnxt: " David Marchand
2016-07-11 14:40             ` [dpdk-dev] [PATCH v4 10/10] net/ena: remove unneeded PCI macro David Marchand
2016-07-11 16:27             ` [dpdk-dev] [PATCH v4 00/10] kill global pci device id list (almost) Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=B27915DBBA3421428155699D51E4CFE20242A14B@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=david.marchand@6wind.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).