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 ABC32454CE; Sat, 22 Jun 2024 16:51:45 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4761D40263; Sat, 22 Jun 2024 16:51:45 +0200 (CEST) Received: from mail-pl1-f180.google.com (mail-pl1-f180.google.com [209.85.214.180]) by mails.dpdk.org (Postfix) with ESMTP id 315144021E for ; Sat, 22 Jun 2024 16:51:44 +0200 (CEST) Received: by mail-pl1-f180.google.com with SMTP id d9443c01a7336-1f9c2847618so25428005ad.1 for ; Sat, 22 Jun 2024 07:51:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1719067903; x=1719672703; 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=3fRq+sw65sQDEH70HRrO6fdxx91Izhpge+3boEJxqcg=; b=aWct2iCBC7teD2EZV2Vw7Zps4BJBFrDQFHcfqnqOcq8sEWSEpVZPVWDF07A/bl0wsA agQ8CllFeveNfOwYjmWwzyxCYEyWA33l9zZvvLcRjCizjj5yBCMBSsSKSrnFpQZoZ/nC FijN14XmvxiGeRSudlo9v65m+lnSNG1YrqzWlL+puxklz9kEC4Nk/CVEtcvr/Y8jzInc FazMI5s3zU8qJGjhyea+hbSa2aAL5KG0kfi3u9IThoz95Kk1eY0H9f4KY5hBuzi016T1 tKMxpuanAILMmVuNAz88ttIsSEIkssRty0Pp2jy13uOdkC5TwIO+dfB988F2oVFi6kyF kCXA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719067903; x=1719672703; 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=3fRq+sw65sQDEH70HRrO6fdxx91Izhpge+3boEJxqcg=; b=cQ5Gf0i2P7iuCQgWbaGuCGjdjhJi+43iIB9qggWPshw1DsFF+XsVQ+GgaPlhweyUHg hk5E+Ow3FRFgd9eeBpDv0FtnWO5QDEstelQlNsQCRBq8PaGxEBAr6iLVHxZeaGnOBE4X oIzwVu6pUHh8lN9iO8c93VbNK7xARi3UrcBaCZMEKqG7OGaEOd6MaxaTv/1k5oVnyuBR fOIgFw10M2by0GFaPXbSQLOR/YYd6yS3/UZvijjgoogEV1vkhug7aajQh1eH5VcTy1fn tUfYX2P0trRR1K/0za1mkMr52q/IWfwYNL5Zd1zXt0WlxaVBa+KQOyBsBO/9Vguh+bl3 7sCA== X-Gm-Message-State: AOJu0Yw6g4kFKXcLd1l2ZIzXK3usnonRDRPFyrX6eIRIkKkXNDcVIRxa J/8t/mfW9BcKz7eJNnePIlONxGrO3RumQ+1ri830uEuPCaYTxZcG8nuMKM/D52M= X-Google-Smtp-Source: AGHT+IGYTpPB+ftviLmQKoEYCyKCrJGC4ngRHRbpk3L08SWUesdBYnFLjMr/WNvmb1Uck+CR5RpeuA== X-Received: by 2002:a17:902:d50e:b0:1f9:ada4:5907 with SMTP id d9443c01a7336-1fa158e5ea4mr8911275ad.36.1719067903097; Sat, 22 Jun 2024 07:51:43 -0700 (PDT) Received: from hermes.lan (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-1f9eb3d507csm31668445ad.192.2024.06.22.07.51.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 22 Jun 2024 07:51:42 -0700 (PDT) From: Stephen Hemminger To: nandinipersad361@gmail.com Cc: dev@dpdk.org, Stephen Hemminger Subject: [PATCH] doc/design: minor cleanus Date: Sat, 22 Jun 2024 07:47:57 -0700 Message-ID: <20240622145140.28803-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240621023254.4258-3-nandinipersad361@gmail.com> References: <20240621023254.4258-3-nandinipersad361@gmail.com> MIME-Version: 1.0 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 Minor fixes to previous edit: 1. remove blank line at end of file, causes git complaint 2. fix minor typo (UTF-8?) 3. break long lines, although rst doesn't care it is nicer for future editors to keep to 100 characters or less. Signed-off-by: Stephen Hemminger --- Depends-on: patch-141466 ("doc: reword design section in contributors guideline") doc/guides/contributing/design.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/guides/contributing/design.rst b/doc/guides/contributing/design.rst index 3d1f5aeb91..77c4d3d823 100644 --- a/doc/guides/contributing/design.rst +++ b/doc/guides/contributing/design.rst @@ -63,9 +63,16 @@ The following macro options can be used: Mbuf features ------------- -A designated area in mbuf stores "dynamically" registered fields and flags. It is the default choice for accommodating new features. The "dynamic" area consumes the remaining space in the mbuf, indicating that it's being efficiently utilized. However, the ``rte_mbuf`` structure must be kept small (128 bytes). +A designated area in mbuf stores "dynamically" registered fields and flags. It is the default choice +for accommodating new features. The "dynamic" area consumes the remaining space in the mbuf, +indicating that it's being efficiently utilized. However, the ``rte_mbuf`` structure must be kept +small (128 bytes). -As more features are added, the space for existinG=g "static" fields (fields that are allocated statically) may need to be reconsidered and possibly converted to "dynamic" allocation. Adding a new static field or flag should be an exception. It must meet specific criteria including widespread usage, performance impact, and size considerations. Before adding a new static feature, it must be justified by its necessity and its impact on the system's efficiency. +As more features are added, the space for existing "static" fields (fields that are allocated +statically) may need to be reconsidered and possibly converted to "dynamic" allocation. Adding a new +static field or flag should be an exception. It must meet specific criteria including widespread +usage, performance impact, and size considerations. Before adding a new static feature, it must be +justified by its necessity and its impact on the system's efficiency. Runtime Information - Logging, Tracing and Telemetry @@ -134,7 +141,8 @@ Mechanism to allow the application to turn library statistics on and off ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Having runtime support for enabling/disabling library statistics is recommended -as build-time options should be avoided. However, if build-time options are used, as in the table library, the options can be set using c_args. +as build-time options should be avoided. However, if build-time options are used, +as in the table library, the options can be set using c_args. When this flag is set, all the counters supported by the current library are collected for all the instances of every object type provided by the library. When this flag is cleared, none of the counters supported by the current library @@ -230,4 +238,3 @@ testing and prototyping purposes while the kernel work is ongoing. It should also be marked with an "EXPERIMENTAL" tag. If the functionality isn't upstreamable, then a case can be made to maintain the PF functionality in DPDK without the EXPERIMENTAL tag. - -- 2.43.0