From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f48.google.com (mail-wm0-f48.google.com [74.125.82.48]) by dpdk.org (Postfix) with ESMTP id 958EB1B31A for ; Mon, 12 Feb 2018 15:20:11 +0100 (CET) Received: by mail-wm0-f48.google.com with SMTP id i186so9866126wmi.4 for ; Mon, 12 Feb 2018 06:20:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=2LBr0bbWEuVAr3DVyw2sxRKjTJQNOtKwiZv+rgEgE5k=; b=yak3bAhV0qn7i+PMwjnxxI9mKu5BEyaWn+yP41sHMO/MrE0FHfQdLx5dZfZ/LuiI3J SvXInzS7lqfgpcw6K5/95w39rpnEoDkNdGMTvSlkgPE2LevgcNWXybyyLR2FXKevTEzK jmg2pab22rROK9HSbVYBtOos5BtRc0+DYGiTi+4fmFakI39KM+VsyGgyj1pn1x8fQ6iY WHOxbgCKuzo9H/MV640izlXCye8i5uH2w5dSCovl64saSWGhGzO5dCXO2htV5mCc8PlD O6NYbs65O64L0MPvCelS+Ks/P/r0MqhDP3CwlwRlYajSoSsFS3xZLQwu5LSEnyPepmm0 qAAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=2LBr0bbWEuVAr3DVyw2sxRKjTJQNOtKwiZv+rgEgE5k=; b=kojUmWT/CYKyYQipiSqZCDaUcogabuZcIhg/nNJVHkuRb8XvdwIZ+kNLTaag0vv6hJ +XkFRXndbPtp5mR6Y4Q2lrBHag/bKZAuVTiNfJcM+HM8ZU/3APXowwvuVUI59pfkJkhZ LwqHa36CDU7mndQ0B0AvXB2VsR9QItcvADdxJfrshcJ8228cPFw+jjgrU4lH7KrPzagQ tHIodcr5wpcH/TU/kXvkjhIUMK6csQti8qw0ky/Ixh/CKrn1NNOSqXY3YWGzZL4Dc0Lq C8FuDSIJqAILibtKp59zTzNtZ+CmqC3TI/FinDJw+NghGHTdQrOUrJcq/1cLI0kBmjjG leLQ== X-Gm-Message-State: APf1xPAMKrjkv3IBPMUq6uMUuwM3Y/fHHgzUPOEZyDXUIjlgqm3tbQrB GtrcrgUdfWR9miAZl2MEJ7CJZw== X-Google-Smtp-Source: AH8x227X0Fxd6SymcFLB1tOUvQRBFTJR+qqtiI5K2UF1P0O3mrpW5PsIEG+sBPxpGuKdEIhDboZIFA== X-Received: by 10.28.26.21 with SMTP id a21mr3371070wma.158.1518445211501; Mon, 12 Feb 2018 06:20:11 -0800 (PST) Received: from 6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id w14sm4966514wmf.32.2018.02.12.06.20.10 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 12 Feb 2018 06:20:10 -0800 (PST) Date: Mon, 12 Feb 2018 15:19:58 +0100 From: Adrien Mazarguil To: Thomas Monjalon Cc: Ophir Munk , dev@dpdk.org, Moti Haimovsky , Olga Shern , Matan Azrad , ferruh.yigit@intel.com Message-ID: <20180212141958.GL4256@6wind.com> References: <1518072954-19082-1-git-send-email-ophirmu@mellanox.com> <1944833.dayHpbUbTZ@xps> <20180212112307.GH4256@6wind.com> <5845713.HXRxCIfSL1@xps> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <5845713.HXRxCIfSL1@xps> Subject: Re: [dpdk-dev] [PATCH v1] doc: update mlx4 flow limitations X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 12 Feb 2018 14:20:12 -0000 On Mon, Feb 12, 2018 at 02:58:31PM +0100, Thomas Monjalon wrote: > 12/02/2018 12:23, Adrien Mazarguil: > > On Fri, Feb 09, 2018 at 05:39:50PM +0100, Thomas Monjalon wrote: > > > I think it's better to have some random thoughts than nothing. > > > All the comments you gave in this thread deserve to be written in > > > the documentation as soon as possible. > > > > Right, but as a side note in the meantime, more complete documentation is > > already available in Doxygen format in mlx4_flow.c. *All* limitations are > > also returned in plain text through error messages (rte_flow_error.message) > > in the same file (git grep 'msg =' drivers/net/mlx4/mlx4_flow.c). > > OK, so we can just point to this file in the documentation and we are done. One remaining issue is that we do not generate documentation out of PMDs since they do not expose public APIs. We can still somehow point to their source code though. > [...] > > > Do you plan to provide a template or an example? > > > > I certainly would like to submit something with the plan I suggested, > > unfortunately I don't have time to work on that at the moment. > > Is it worth the effort, given it is already documented in code? I don't think it's super urgent but I definitely think it would still be useful, if only to summarize all quirks at once in one place instead of leaving users discover them through trial & error as only one error can be reported at once. Keep in mind not all features/limitations are documented in Doxygen format; PMDs are not forced to have one parse function per pattern item for instance. In mlx4, supported actions are handled by a common function and are not documented individually. -- Adrien Mazarguil 6WIND