* How to remove a word from the dictionary.txt we are using in the CI/CD pipeline. @ 2024-04-15 20:41 Aditya Ambadipudi 2024-04-15 21:17 ` Honnappa Nagarahalli 0 siblings, 1 reply; 4+ messages in thread From: Aditya Ambadipudi @ 2024-04-15 20:41 UTC (permalink / raw) To: ci; +Cc: Honnappa Nagarahalli, Dhruv Tripathi, Wathsala Wathawana Vithanage [-- Attachment #1: Type: text/plain, Size: 1609 bytes --] 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-aditya.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 dictionary 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 data 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 IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you. [-- Attachment #2: Type: text/html, Size: 8276 bytes --] ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: How to remove a word from the dictionary.txt we are using in the CI/CD pipeline. 2024-04-15 20:41 How to remove a word from the dictionary.txt we are using in the CI/CD pipeline Aditya Ambadipudi @ 2024-04-15 21:17 ` Honnappa Nagarahalli 2024-04-15 22:19 ` Patrick Robb 0 siblings, 1 reply; 4+ messages in thread From: Honnappa Nagarahalli @ 2024-04-15 21:17 UTC (permalink / raw) To: Aditya Ambadipudi, ci, Patrick Robb Cc: Dhruv Tripathi, Wathsala Wathawana Vithanage, Paul Szczepanek, nd [-- Attachment #1: Type: text/plain, Size: 1677 bytes --] + Patrick From: Aditya Ambadipudi <Aditya.Ambadipudi@arm.com> Date: Monday, April 15, 2024 at 3:41 PM To: ci@dpdk.org <ci@dpdk.org> Cc: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>, Dhruv Tripathi <Dhruv.Tripathi@arm.com>, Wathsala Wathawana Vithanage <wathsala.vithanage@arm.com> 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-aditya.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 dictionary 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 data 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 [-- Attachment #2: Type: text/html, Size: 7952 bytes --] ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: How to remove a word from the dictionary.txt we are using in the CI/CD pipeline. 2024-04-15 21:17 ` Honnappa Nagarahalli @ 2024-04-15 22:19 ` Patrick Robb 2024-04-16 7:19 ` Thomas Monjalon 0 siblings, 1 reply; 4+ messages in thread From: Patrick Robb @ 2024-04-15 22:19 UTC (permalink / raw) To: Honnappa Nagarahalli Cc: Aditya Ambadipudi, ci, Dhruv Tripathi, Wathsala Wathawana Vithanage, Paul Szczepanek, nd, Ali Alnubani, Aaron Conole, dev 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 PM Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com> wrote: > > + Patrick > > > > From: Aditya Ambadipudi <Aditya.Ambadipudi@arm.com> > Date: Monday, April 15, 2024 at 3:41 PM > To: ci@dpdk.org <ci@dpdk.org> > Cc: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>, Dhruv Tripathi <Dhruv.Tripathi@arm.com>, Wathsala Wathawana Vithanage <wathsala.vithanage@arm.com> > 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-aditya.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 dictionary 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 data 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 > > > ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: How to remove a word from the dictionary.txt we are using in the CI/CD pipeline. 2024-04-15 22:19 ` Patrick Robb @ 2024-04-16 7:19 ` Thomas Monjalon 0 siblings, 0 replies; 4+ messages in thread From: Thomas Monjalon @ 2024-04-16 7:19 UTC (permalink / raw) To: Honnappa Nagarahalli, ci Cc: Aditya Ambadipudi, ci, Dhruv Tripathi, Wathsala Wathawana Vithanage, Paul Szczepanek, nd, Ali Alnubani, Aaron Conole, dev, Patrick Robb We have such exception already: devtools/build-dict.sh 16/04/2024 00:19, Patrick Robb: > 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 PM Honnappa Nagarahalli > <Honnappa.Nagarahalli@arm.com> wrote: > > > > + Patrick > > > > > > > > From: Aditya Ambadipudi <Aditya.Ambadipudi@arm.com> > > Date: Monday, April 15, 2024 at 3:41 PM > > To: ci@dpdk.org <ci@dpdk.org> > > Cc: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>, Dhruv Tripathi <Dhruv.Tripathi@arm.com>, Wathsala Wathawana Vithanage <wathsala.vithanage@arm.com> > > 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-aditya.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 dictionary 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 data 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 > > > > > > > ^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-04-16 7:19 UTC | newest] Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2024-04-15 20:41 How to remove a word from the dictionary.txt we are using in the CI/CD pipeline Aditya Ambadipudi 2024-04-15 21:17 ` Honnappa Nagarahalli 2024-04-15 22:19 ` Patrick Robb 2024-04-16 7:19 ` Thomas Monjalon
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).