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 534E843E80; Tue, 16 Apr 2024 00:19:39 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3A68D402EC; Tue, 16 Apr 2024 00:19:39 +0200 (CEST) Received: from mail-ot1-f47.google.com (mail-ot1-f47.google.com [209.85.210.47]) by mails.dpdk.org (Postfix) with ESMTP id A4C07402B2 for ; Tue, 16 Apr 2024 00:19:37 +0200 (CEST) Received: by mail-ot1-f47.google.com with SMTP id 46e09a7af769-6eb7c4e9015so785845a34.2 for ; Mon, 15 Apr 2024 15:19:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1713219577; x=1713824377; darn=dpdk.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=Y3k+J2M4v3gWAwZRLXkGlTZbwyGwilyCoZY/N1arF6Y=; b=WzA1aTwrAnW1o1HnuleaPzDIwTK5VGmnBLitXeyX378h6YbcExTmuL/BI8BbzsTm/P p43Fav8aNuLVhPuJYVuK3mSzGltBbMKJa/8jDXpF7IIu1pfsCRAAgNbZCGB6/1dshxBt S5WCRIXacTvH2dQDpRPnfC02PFWNsWcO3OHto= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713219577; x=1713824377; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Y3k+J2M4v3gWAwZRLXkGlTZbwyGwilyCoZY/N1arF6Y=; b=mVB2X2MvV6cAGEH8tWge/QYqOnsx7Q6snWch4c6V8uOVEexA/01NGYHMdWbp0TnFJk hpckA6/47opL+H90RQQypX+YcehFpNsRcXZiopiwlxcQAg9rnf2xY39yIUo1DvA/KM39 oIFduXn3tMOecfH1hPubJr+VOZULeURMwNY/LJZrZZwWGZsQ/o+y7qh7Kb5pDl79196h waCaAOOL2SwT328+7YiCsOoVY6ekdvlpdH3qY8PzDluce11RGQvuzqEGxSnzqiSBT7fL ekZBYnAjS1n7OB6D/y2wEUUGkKgjDrlI6i7gVjS0su5dEac1s58CgGgjbZfD9b8XcEpx 4t8g== X-Forwarded-Encrypted: i=1; AJvYcCU2KAFbNWpAyVJAkbau78SBYHCNV3EB1tCn56/0lHOQvTHH3lWICWnpDimyNUWLOL9FVI2PiTKM3wUyfYU= X-Gm-Message-State: AOJu0Yzg1xpFnxvAOcrWb3uDDd9qQs2VV4v+u7ElvOXrbwKmjJnu9yxf +0cyHR3y+XtTDzu9554mcIgV05e792u0aRxYaOJfHXyhqZbzlpndzwQbuJkdVtvt0kielkOQqNz l78kTlY7hks3YtRbvVb0UTu6pr8ulfZgYLD95PA== X-Google-Smtp-Source: AGHT+IFsqF5TX0F1iYDvBdaJB1C2IJSp166DNUIv813CKBYwJYSiyyPUNdwDu8382GFoHkmVvxijU0gr1Febsn/Pw78= X-Received: by 2002:a05:6870:40c4:b0:235:478:db05 with SMTP id l4-20020a05687040c400b002350478db05mr1112103oal.27.1713219576916; Mon, 15 Apr 2024 15:19:36 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Patrick Robb Date: Mon, 15 Apr 2024 18:19:26 -0400 Message-ID: Subject: Re: How to remove a word from the dictionary.txt we are using in the CI/CD pipeline. To: Honnappa Nagarahalli Cc: Aditya Ambadipudi , "ci@dpdk.org" , Dhruv Tripathi , Wathsala Wathawana Vithanage , Paul Szczepanek , nd , Ali Alnubani , Aaron Conole , dev Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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 Hi Aditya, I don't run these CI checks, but I think the checkpatch script in CI is using https://github.com/codespell-project/codespell as the dictionary provider. So, one possibility is suggesting to that project that deque is a valid word which should be supported in software projects. Then, the person who maintains this check would have to update their codespell repo. I haven't tried submitting such a change to this project before, but it looks like they have some open PRs for word policy suggestions like yours: https://github.com/codespell-project/codespell/pull/2812 It looks like the first and fourth from this list would need to become valid uses? ./codespell_lib/data/dictionary_code.txt:deque->dequeue ./codespell_lib/data/dictionary.txt:dequed->dequeued ./codespell_lib/data/dictionary.txt:dequeing->dequeuing ./codespell_lib/data/dictionary.txt:deques->dequeues Ali, are you the person who maintains the checkpatch run which posts results to patchwork? Otherwise I think it is up to the DPDK maintainers to decide if an exception is appropriate. I believe they have done this in the past. It might not hurt to suggest the change to codespell, and then if they're not on board, requesting an exception for your DPDK patch. One possibility is starting a DPDK specific exceptions list, which people could add to alongside their patches. I don't think the maintainers will favor this though as I expect they will want to keep checkpatch pretty simple and standard. Adding the dev mailing list as I'm guessing other DPDK devs have run into the same issue and might be able to provide more feedback. On Mon, Apr 15, 2024 at 5:17=E2=80=AFPM Honnappa Nagarahalli wrote: > > + Patrick > > > > From: Aditya Ambadipudi > Date: Monday, April 15, 2024 at 3:41=E2=80=AFPM > To: ci@dpdk.org > Cc: Honnappa Nagarahalli , Dhruv Tripathi <= Dhruv.Tripathi@arm.com>, Wathsala Wathawana Vithanage > Subject: How to remove a word from the dictionary.txt we are using in the= CI/CD pipeline. > > Hello folks, > > My name is Aditya Ambadipudi. I work as a software engineer at Arm. > > Recently we submitted a patch set for DPDK: > > http://patches.dpdk.org/project/dpdk/patch/20240401013729.1466298-3-adity= a.ambadipudi@arm.com/ > > And the CI/CD is failing for this patch because of the word Deque. > > 1787:adaquate->adequate > > 1788:adaquately->adequately > > 1789:adaquetely->adequately > > 1790:adaquit->adequate > > 1791:adaquitly->adequately > > 1975:adecuate->adequate > > 1977:adequat->adequate > > 1978:adequatly->adequately > > 1979:adequit->adequate > > 1980:adequite->adequate > > 1981:adequitely->adequately > > 1982:adequitly->adequately > > 18484:dequed->dequeued > > 18485:dequeing->dequeuing > > 18486:deques->dequeues > > 30005:inadiquate->inadequate > > 30006:inadquate->inadequate > > 61309:deque->dequeue > > > > > > Code spell wants us to substitute all the places where we used the word "= deque" with "dequeue". > > > > We were wondering if it is possible to remove this rule from that diction= ary that the CI/CD pipeline uses. Or if there is a way to circumvent that = rule. > > The CR we created was specifically to add a Deque library to DPDK. The da= ta structure we have created is a Deque and there is no other word that we = can think of that describes that data structure better than "Deque". > > > > Thank you, > > Aditya Ambadipudi > > >