From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 58D434559C; Fri, 5 Jul 2024 20:33:35 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 436E54325E; Fri, 5 Jul 2024 20:33:35 +0200 (CEST) Received: from mail-qk1-f182.google.com (mail-qk1-f182.google.com [209.85.222.182]) by mails.dpdk.org (Postfix) with ESMTP id 1FA28410FD for ; Fri, 5 Jul 2024 20:33:34 +0200 (CEST) Received: by mail-qk1-f182.google.com with SMTP id af79cd13be357-79d5ff2c4f2so4554385a.0 for ; Fri, 05 Jul 2024 11:33:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1720204413; x=1720809213; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=wtf7OAoTgKEP0+bpw6Uu41Jvhsr2K6Wq0k8M1AlrZNM=; b=ejpQ4348RwLYVylx1xP1p/kkgDeYIIDSHJwaeQEa0n6fe50tLNbe4/ij7qJncxMfSt vTcYRQJ/eq5u0QTIKDsEXfLyMuR5kFw5Xz30Q1vfbvB6sW+XajrmFF/61NL5eTZ4ql/M mNfsPXHTPKn/vs8jNPDsgKRiJJgTZ7duoljSk= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720204413; x=1720809213; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=wtf7OAoTgKEP0+bpw6Uu41Jvhsr2K6Wq0k8M1AlrZNM=; b=gzFz5ev29W1RnTtk3nuRK550LSS3TiAO9xzUvw8dboWL8JUlyKlP9Nsgj5htEwLt+j S84KKOjjOoP9we/FN703jQKLknE+1tvJ0r0k02NQxf3S6RrL0ThhwsMm2ojlArUyWrep /O/s01dKgh2z2KqIuYxc1D6Y3w8Yxp5iFZCHqLNrvJQSOcExwQkDac7sITJ8Qoka2kfr /SpNlk3QR4m+QaUlx4B7F1UPRaDal4w1CXeJ4t8/1pjWyws8cNCNu9Qgi3s5duWwW90G AGFEDsg9gNUBkGGW9HUsttagdZ3MltTIMHQ5/tjoRHzoJXSzWNe4Ll5VPUif0pNnhXm7 YIcw== X-Gm-Message-State: AOJu0YwhwZlcUVXF01dqMZ2RQ0MfKKQmg//l/SYxHeMnvf5vlTKMSo/B S724qfMO1ZfgGdhUljIxc3LUwyM1O/agw99+p0Whmc3G+eyAtkPL84s7heDHFD8= X-Google-Smtp-Source: AGHT+IFnHvfQDLzRkxJaqVU+aQf7UifeWdyLYuipXsLtesRXmo2+ZpwChJgG1qCrxTkgQmSDug3mtw== X-Received: by 2002:a05:620a:2101:b0:79d:69b5:aaff with SMTP id af79cd13be357-79eee28ff06mr476777185a.6.1720204413475; Fri, 05 Jul 2024 11:33:33 -0700 (PDT) Received: from localhost.unh.edu ([2606:4100:3880:1257::1003]) by smtp.gmail.com with ESMTPSA id af79cd13be357-79d88a192f8sm579654385a.68.2024.07.05.11.33.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 05 Jul 2024 11:33:32 -0700 (PDT) From: Nicholas Pratte To: dmarx@iol.unh.edu, paul.szczepanek@arm.com, juraj.linkes@pantheon.tech, yoan.picchi@foss.arm.com, jspewock@iol.unh.edu, luca.vizzarro@arm.com, probb@iol.unh.edu, Honnappa.Nagarahalli@arm.com Cc: dev@dpdk.org, Nicholas Pratte Subject: [PATCH v2 6/6] doc: dpdk documentation changes for new dts config Date: Fri, 5 Jul 2024 14:33:24 -0400 Message-ID: <20240705183325.32381-1-npratte@iol.unh.edu> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240705171341.23894-2-npratte@iol.unh.edu> References: <20240705171341.23894-2-npratte@iol.unh.edu> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Adjusted DPDK documentation to reflect the changes made to the dts conf.yaml configuration file. Bugzilla ID: 1360 Signed-off-by: Nicholas Pratte --- doc/guides/tools/dts.rst | 26 ++++++-------------------- 1 file changed, 6 insertions(+), 20 deletions(-) diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst index 515b15e4d8..a64580e0de 100644 --- a/doc/guides/tools/dts.rst +++ b/doc/guides/tools/dts.rst @@ -437,14 +437,6 @@ _`Node name` *string* – A unique identifier for a node. **Examples**: ``SUT1``, ``TG1``. -_`ARCH` - *string* – The CPU architecture. - **Supported values**: ``x86_64``, ``arm64``, ``ppc64le``. - -_`CPU` - *string* – The CPU microarchitecture. Use ``native`` for x86. - **Supported values**: ``native``, ``armv8a``, ``dpaa2``, ``thunderx``, ``xgene1``. - _`OS` *string* – The operating system. **Supported values**: ``linux``. @@ -456,9 +448,6 @@ _`Build target` *mapping* – Build targets supported by DTS for building DPDK, described as: ==================== ================================================================= - ``arch`` See `ARCH`_ - ``os`` See `OS`_ - ``cpu`` See `CPU`_ ``compiler`` See `Compiler`_ ``compiler_wrapper`` *string* – Value prepended to the CC variable for the DPDK build. @@ -565,18 +554,15 @@ involved in the testing. These can be defined with the following mappings: | | | | | **NB**: Use only as last resort. SSH keys are **strongly** preferred. | +-----------------------+---------------------------------------------------------------------------------------+ - | ``arch`` | The architecture of this node. See `ARCH`_ for supported values. | - +-----------------------+---------------------------------------------------------------------------------------+ | ``os`` | The operating system of this node. See `OS`_ for supported values. | +-----------------------+---------------------------------------------------------------------------------------+ - | ``lcores`` | | (*optional*, defaults to 1) *string* – Comma-separated list of logical | - | | | cores to use. An empty string means use all lcores. | - | | | - | | **Example**: ``1,2,3,4,5,18-22`` | + | ``dpdk_config`` | Configuration relating to DPDK (to be specified on SUT Nodes) | +-----------------------+---------------------------------------------------------------------------------------+ - | ``use_first_core`` | (*optional*, defaults to ``false``) *boolean* | + | ``lcores`` | | (*optional*, defaults to 1 if not used) *string* – Comma-separated list of logical | + | | | cores to use. An empty string means use all lcores except core 0. core 0 is used | + | | | only when explicitly specified | | | | - | | Indicates whether DPDK should use only the first physical core or not. | + | | **Example**: ``1,2,3,4,5,18-22`` | +-----------------------+---------------------------------------------------------------------------------------+ | ``memory_channels`` | (*optional*, defaults to 1) *integer* | | | | @@ -617,4 +603,4 @@ And they both have two network ports which are physically connected to each othe .. literalinclude:: ../../../dts/conf.yaml :language: yaml - :start-at: test_runs: + :start-at: test_runs: \ No newline at end of file -- 2.44.0