From patchwork Thu Aug 1 15:46:39 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 142846 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id AAC6F456BF; Thu, 1 Aug 2024 17:49:25 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0305243486; Thu, 1 Aug 2024 17:48:43 +0200 (CEST) Received: from mail-pl1-f175.google.com (mail-pl1-f175.google.com [209.85.214.175]) by mails.dpdk.org (Postfix) with ESMTP id 71909433BD for ; Thu, 1 Aug 2024 17:48:37 +0200 (CEST) Received: by mail-pl1-f175.google.com with SMTP id d9443c01a7336-1ff1cd07f56so51187115ad.2 for ; Thu, 01 Aug 2024 08:48:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1722527316; x=1723132116; 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=Q4svX+cvxxUu66iMesV2Z7l1MKe24zjQDTO2ZtaH90I=; b=p4fs9HpDEe3O1dzCgBpGzok9JiIJ14td3yDf64M3AweHJa/81mkBna3rYk5N7u1Xn1 Cuyn76C7f+bXPSEolqRYgNscTJ8aK4NW/GSM294Sx0EsSTZ2EFsxk9qegHuAWsyf/0vY FjS7xBYnCXf2QUw3eGX09PRsJdD5i5gLmTLAlW8YQYqgw5xEQmgvNqMyWMlz52iazHFn dUMGhqS5n0doF8RvjuJoVtxLVXoz0IWfMOIMwZIiElihvEMpE9HGIb2Mg/vZY6NnjtrK zNRr6KqorCJjtG7id/Y4DmTjKPgVkZvTZr3RlS71qQa7aQIqEYexjGVjPbkU4rVDq3+u TxpA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1722527316; x=1723132116; 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=Q4svX+cvxxUu66iMesV2Z7l1MKe24zjQDTO2ZtaH90I=; b=TV4TTf18ONGMiGRRpqqWf/buCC6G4aHDF2v7OOTF2sIQnNA6t+KqMKFXEIaBEQ+GZ+ PTMUSAt8sJgIeHxXXE7P/oFskKX5YGYkyKIYtZXmomGCRHXDdWzFri8SkYB+4kX41InX 5LS4aSWuHoYbjOcF9adlQiT+CeYXYRs+Yb9I2rHCX5rAjj4UK13+tfm51d5DUWKaMrnS rZSGzbILj607tuL+MdZqLeWE+rLU1XxJalFmJnQ+cBO8W6EBcSAOGtN2rRdC6UuCjKS8 YbZl/vMhIFEcdKPxmTtz6ziqxbCDJPasshGrw7nj4uccIfZiE3XFsPjG0o3rzuTejTjZ qWaQ== X-Gm-Message-State: AOJu0YwG6s9dOvwJttSGYjIMtt1N2bN+q4sqSESONlTiLVtRGJuJDF2z qIqnylPvnAgxAjVWOYThWM2MptQEujiBfisGRHYFLemhLV4TS0589zP8mxvC7em2rK6loOe4Afb a X-Google-Smtp-Source: AGHT+IFWyZgN5009ieYspEnaecK1uwv5F1x5klYjg+2/eRQJdQLVuH8j1I5Z2uENSKTNP6hfADBkDg== X-Received: by 2002:a17:902:ced2:b0:1fd:876f:ed79 with SMTP id d9443c01a7336-1ff574dfd8cmr7123555ad.65.1722527316562; Thu, 01 Aug 2024 08:48:36 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-1ff590579b3sm92405ad.178.2024.08.01.08.48.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 01 Aug 2024 08:48:36 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Subject: [PATCH v11 6/7] doc: remove sanity Date: Thu, 1 Aug 2024 08:46:39 -0700 Message-ID: <20240801154821.150443-7-stephen@networkplumber.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240801154821.150443-1-stephen@networkplumber.org> References: <20240529233811.663211-1-stephen@networkplumber.org> <20240801154821.150443-1-stephen@networkplumber.org> MIME-Version: 1.0 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 Don't use the word sanity in the documentation Signed-off-by: Stephen Hemminger --- doc/guides/gpus/cuda.rst | 2 +- doc/guides/sample_app_ug/eventdev_pipeline.rst | 2 +- doc/guides/tools/testbbdev.rst | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/guides/gpus/cuda.rst b/doc/guides/gpus/cuda.rst index 6520c17c3e..c523da1f3e 100644 --- a/doc/guides/gpus/cuda.rst +++ b/doc/guides/gpus/cuda.rst @@ -80,7 +80,7 @@ Similarly to CUDA shared library, if the **libgdrapi.so** shared library is not installed in default locations (e.g. /usr/local/lib), you can use the variable ``GDRCOPY_PATH_L``. -As an example, to enable the CPU map feature sanity check, +As an example, to enable the CPU map feature check, run the ``app/test-gpudev`` application with: .. code-block:: console diff --git a/doc/guides/sample_app_ug/eventdev_pipeline.rst b/doc/guides/sample_app_ug/eventdev_pipeline.rst index 19ff53803e..e7787fb266 100644 --- a/doc/guides/sample_app_ug/eventdev_pipeline.rst +++ b/doc/guides/sample_app_ug/eventdev_pipeline.rst @@ -50,7 +50,7 @@ these settings is shown below: .//examples/dpdk-eventdev_pipeline -l 0,2,8-15 --vdev event_sw0 \ -- -r1 -t1 -e4 -w FF00 -s4 -n0 -c32 -W1000 -D -The application has some sanity checking built-in, so if there is a function +The application has some internal validation, so if there is a function (e.g.; the RX core) which doesn't have a cpu core mask assigned, the application will print an error message: diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index ddb8d787be..baaf9d115d 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -9,7 +9,7 @@ dpdk-test-bbdev Application The ``dpdk-test-bbdev`` tool is a Data Plane Development Kit (DPDK) utility that allows measuring performance parameters of PMDs available in the bbdev framework. Tests available for execution are: latency, throughput, validation, -bler and sanity tests. Execution of tests can be customized using various +bler and basic functionality. Execution of tests can be customized using various parameters passed to a python running script. @@ -97,8 +97,8 @@ Test Cases There are 7 main test cases that can be executed using testbbdev tool: -* Sanity checks [-c unittest] - - Performs sanity checks on BBDEV interface, validating basic functionality +* Functional checks [-c unittest] + - Performs checks on BBDEV interface, validating basic functionality * Validation tests [-c validation] - Performs full operation of enqueue and dequeue @@ -232,7 +232,7 @@ vector name refer more explicitly processing specificity such as is purely read/written for external DDR, lbrm when limited buffer rate matching is expected, or crc_fail when a CRC failure is expected. They are chosen to have a good coverage across sizes and processing -parameters while still keeping their number limited as part of sanity +parameters while still keeping their number limited as part of functional regression. Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled and output