From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-yw0-f176.google.com (mail-yw0-f176.google.com [209.85.161.176]) by dpdk.org (Postfix) with ESMTP id 8D5129E3 for ; Wed, 31 Aug 2016 09:47:55 +0200 (CEST) Received: by mail-yw0-f176.google.com with SMTP id z8so26073631ywa.1 for ; Wed, 31 Aug 2016 00:47:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=canonical-com.20150623.gappssmtp.com; s=20150623; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=HL6Lhn2G7bNu4z4iGuByQcCYA02qEP6brWF+QqfuWI0=; b=k+BWNUzUL4IAMDC32AAlhRs7kxVOtevLB23/LWlyBrC+gNxwjSgPGfiPvNUnCbr9kb FhkrEaCf2e9KggHBlFt+gkVhXuBXhzB5YVn1edtn5IQcDxLmTJFatBKS2gqIk4HWqmbf nqbqr6CnVjRt1Jd+zpWc0vP3CQkKpJaexHq+w6CTnRq0DMWa1L12/BS10phBfOlpdj6K hFJoIv5BO9kGlyUS4wX3CWE/rnvkZXEV9f95zMllEZcZkDimCRL111p0+d5juFFmvGws 5AyPNpkHm5RpWcFMSdWZmhKA81ww1tEy7fp1ZWiTz9IjB606kw95JFk1gu80q950pcx/ ZktA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=HL6Lhn2G7bNu4z4iGuByQcCYA02qEP6brWF+QqfuWI0=; b=CKYqCGkfE7mzGzJ7IdwoM+flK7AKiaGaRI08LvsgF2Dq9f2vBQJVXGR6AayQWjs8yd zv+2T5tovfoVgy6KiCT/uBpDvKC4Y3VRtpB9YnATbEdSQvQDXpmk3n1o6ASi8wFxwCbq vxgg3WkPwjLQvPNw/4gAY0CmbT/4uLkdVXqlKfAtvlnqebwLuPwiVzzlRYoKBfUlX9SI S5yQ2fu6eh39Qr0BmsAKZkRPjtElNaSim87iFXe7WXnduIaV94HdsOsYNrqsgDJDcfK5 8yYC8Zr1tOY2Y5hklJ2s4MLeuPbXQjVC65cuAMoXG3OABrEOq/58DXuxl/+p5BoNvEl5 vGPQ== X-Gm-Message-State: AE9vXwOixtoS9mm+wIxL/YojVMkd8HYVxvmVJHdEEj6YokXOnOxsGbEJ55Pyas2OD7r5nbdXT5zAUMPAQUNDx5FC X-Received: by 10.129.159.131 with SMTP id w125mr7186138ywg.168.1472629674952; Wed, 31 Aug 2016 00:47:54 -0700 (PDT) MIME-Version: 1.0 Received: by 10.13.243.194 with HTTP; Wed, 31 Aug 2016 00:47:24 -0700 (PDT) In-Reply-To: References: <1470309419-4389-1-git-send-email-christian.ehrhardt@canonical.com> <1470309419-4389-4-git-send-email-christian.ehrhardt@canonical.com> From: Christian Ehrhardt Date: Wed, 31 Aug 2016 09:47:24 +0200 Message-ID: To: "Mcnamara, John" Cc: "thomas.monjalon@6wind.com" , "dev@dpdk.org" Content-Type: text/plain; charset=UTF-8 X-Content-Filtered-By: Mailman/MimeDel 2.1.15 Subject: Re: [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for dpdk-devbind X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 31 Aug 2016 07:47:55 -0000 Hi, thanks for sharing your RST experience - I didn't see the rst issues before. Fixed them all and checked html/man output again - looking good to me. On Tue, Aug 30, 2016 at 5:05 PM, Mcnamara, John wrote: > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Christian Ehrhardt > > Sent: Thursday, August 4, 2016 12:17 PM > > To: christian.ehrhardt@canonical.com; thomas.monjalon@6wind.com; > > dev@dpdk.org > > Subject: [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for dpdk- > > devbind > > > > + > > +OPTIONS > > +------- > > + > > +* ``--help, --usage`` > > + > > + Display usage information and quit > > + > > +* ``-s, --status`` > > + > > + Print the current status of all known network interfaces. > > + For each device, it displays the PCI domain, bus, slot and > > function, > > + along with a text description of the device. Depending upon > > whether the > > + device is being used by a kernel driver, the igb_uio driver, or > > no > > + driver, other relevant information will be displayed: > > + * the Linux interface name e.g. if=eth0 > > + * the driver being used e.g. drv=igb_uio > > + * any suitable drivers not currently using that device > > + e.g. unused=igb_uio > > + NOTE: if this flag is passed along with a bind/unbind option, > the > > + status display will always occur after the other operations have > > taken > > + place. > > There are a few RST errors in this file. One of theme relates to the second > level bullet list above. There should be a blank line before and after the > list. > > Also, "e.g. unused=igb_uio" should be joined to, or aligned with, the > previous > line. > > Also, it would be better to quote any fixed width strings in the docs with > ```` > quotes, like ``unused=igb_uio``. This could be applied to any of the > ``--options`` > in the text as well. > > +Examples > > +-------- > > + > > +To display current device status: > > +.. code-block:: console > > + > > + dpdk-devbind --status > > + > > All the "code-block" directives should have a blank line before them. > However it is probably better to use the simpler :: directive, like: > > To display current device status:: > > dpdk-devbind --status > > -- Christian Ehrhardt Software Engineer, Ubuntu Server Canonical Ltd