From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gaetan.rivet@6wind.com>
Received: from mail-wr0-f193.google.com (mail-wr0-f193.google.com
 [209.85.128.193]) by dpdk.org (Postfix) with ESMTP id 362131066
 for <dev@dpdk.org>; Tue, 24 Apr 2018 01:55:24 +0200 (CEST)
Received: by mail-wr0-f193.google.com with SMTP id v15-v6so27628789wrm.10
 for <dev@dpdk.org>; Mon, 23 Apr 2018 16:55:24 -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:in-reply-to:references
 :in-reply-to:references;
 bh=LW6JnKlsBYZc3YWjn785PbwZjphLvkbVOdNCNZiMRKA=;
 b=q53ItRhcZQRnSIOC27mSnXnISE6BLh0cjGeIPUZ0kOvEjVRMb4L3N9hYUPt7RDIk+g
 C6B6fFHP/AjDTFw2/lIQUKAqHcB1ihne6IEdc3+sFzfXO5+oxrUSSQ8eF4Nv5j8F5h60
 e9eRDLjeuraGb2SQoG9sxwgpHC0l9PITPOlMZxuc96vx2GUR4zOWOtxx24Co4Nw+dMDZ
 ve7/x0plSBB0sNWsK/mNdDpGlnTefCvX8hTL/hBjUNqJQdM/nqZKF89TVQWjUlCiS/FT
 ehWfTwOr9vf67zWUDnLGB6/KSHZYQnrybAxAntLTUXDNlWOXnYwIz/RfSIA5318gdehu
 wyyA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
 :references:in-reply-to:references;
 bh=LW6JnKlsBYZc3YWjn785PbwZjphLvkbVOdNCNZiMRKA=;
 b=DfyI/wMYsM5xf7TuM+IR4HBL237ZW3+1pJISMg4TpvSVKJOLBKJJjxozZIpDSVE5Fj
 Z3JNmDP2KsYwgQAOnOlCUIX+iqVyHHa4cB+vC4fmN9X5azv6+NxjU1Mzds9B7Txq/qef
 JblG6JPhmY7mIp1fsNEUK0vSYeIbxwan84tY+oat+s2vSAACtnh0uU/X5O4qvD0FXZ2N
 7cBB3DJJB4KbRnzL3/OmOugpIIhff62j4TuNO98RBRjBqtCsUY9KQLiLPAnWk/HPhDey
 mO5I6EjBnKT216qTLmJ5DhLsYDna2GaqE1YIT6zKuAviJhvb9QlA1Xx2eQrFddDaNyhC
 JemQ==
X-Gm-Message-State: ALQs6tCcqapKBk5icabjb2J/Ee/yw0IkuR7FVAB4mD1jodJvZOAODbDo
 0B3KtSdAHiBPaMZ6XD8WGxfi4jnB
X-Google-Smtp-Source: AIpwx48VJtuIKFtxTQJl+fLQ/07oXksgiNGgt/QjAUplIjwJ+AAer36D31KmaPpTJ8BlV0136rWaxg==
X-Received: by 10.28.136.4 with SMTP id k4mr10987786wmd.133.1524527723570;
 Mon, 23 Apr 2018 16:55:23 -0700 (PDT)
Received: from bidouze.dev.6wind.com. (host.78.145.23.62.rev.coltfrance.com.
 [62.23.145.78])
 by smtp.gmail.com with ESMTPSA id 55-v6sm28922279wrw.52.2018.04.23.16.55.22
 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Mon, 23 Apr 2018 16:55:22 -0700 (PDT)
From: Gaetan Rivet <gaetan.rivet@6wind.com>
To: dev@dpdk.org
Cc: Gaetan Rivet <gaetan.rivet@6wind.com>
Date: Tue, 24 Apr 2018 01:54:50 +0200
Message-Id: <6c0a7648edd0431b0053dba3c784c93593cdd00b.1524527213.git.gaetan.rivet@6wind.com>
X-Mailer: git-send-email 2.11.0
In-Reply-To: <cover.1524527213.git.gaetan.rivet@6wind.com>
References: <cover.1503676587.git.gaetan.rivet@6wind.com>
 <cover.1524527213.git.gaetan.rivet@6wind.com>
In-Reply-To: <cover.1524527213.git.gaetan.rivet@6wind.com>
References: <cover.1524527213.git.gaetan.rivet@6wind.com>
Subject: [dpdk-dev] [PATCH v5 08/10] devargs: update devargs add
	documentation
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://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: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 23 Apr 2018 23:55:25 -0000

Device syntax documentation is out of date.

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/librte_eal/common/include/rte_devargs.h | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/lib/librte_eal/common/include/rte_devargs.h b/lib/librte_eal/common/include/rte_devargs.h
index eff7a3f8c..bfe4da4fd 100644
--- a/lib/librte_eal/common/include/rte_devargs.h
+++ b/lib/librte_eal/common/include/rte_devargs.h
@@ -96,6 +96,21 @@ int rte_eal_parse_devargs_str(const char *devargs_str,
  *
  * The device string is built with a printf-like syntax.
  *
+ * The syntax is:
+ *
+ *     bus:device_identifier,arg1=val1,arg2=val2
+ *
+ * where "bus:" is the bus name followed by any character separator.
+ * The bus name is optional. If no bus name is specified, each bus
+ * will attempt to recognize the device identifier. The first one
+ * to succeed will be used.
+ *
+ * Examples:
+ *
+ *     pci:0000:05.00.0,arg=val
+ *     05.00.0,arg=val
+ *     vdev:net_ring0
+ *
  * @param da
  *   The devargs structure holding the device information.
  * @param format
@@ -125,16 +140,7 @@ rte_eal_devargs_insert(struct rte_devargs *da);
 
 /**
  * Add a device to the user device list
- *
- * For PCI devices, the format of arguments string is "PCI_ADDR" or
- * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
- * "04:00.0,arg=val".
- *
- * For virtual devices, the format of arguments string is "DRIVER_NAME*"
- * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
- * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
- * driver name is not checked by this function, it is done when probing
- * the drivers.
+ * See rte_eal_devargs_parse() for details.
  *
  * @param devtype
  *   The type of the device.
-- 
2.11.0