From patchwork Wed Nov 20 13:27:13 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kevin Traynor X-Patchwork-Id: 63162 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4B76BA04C1; Wed, 20 Nov 2019 14:27:41 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id BDBD72956; Wed, 20 Nov 2019 14:27:40 +0100 (CET) Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by dpdk.org (Postfix) with ESMTP id A53392142 for ; Wed, 20 Nov 2019 14:27:39 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1574256459; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=0uGjEwx8BXiP8Vi5eq/ADYawDR3K7fC7XYW4oHEg+QY=; b=Qo4LNUbLTZ0AL8GEruEtL8otGF6fOHqt9T9Hqtv7VqS6xyOvUDsvJSDJDye5+G0MndHZu+ PInP4aMRniTOZhvInBJAKorQX2oJWt6SSZIBhn3UhJB8hCHrBdYFYXp6Zqi/4CUGRfLZn3 CbwrBoVPMb5yQqJZo6irqtAFuYq7uDU= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-110-OKiBOpVIPL-WwEWNuLDdBg-1; Wed, 20 Nov 2019 08:27:37 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 42C8B100550E; Wed, 20 Nov 2019 13:27:36 +0000 (UTC) Received: from rh.redhat.com (unknown [10.36.118.36]) by smtp.corp.redhat.com (Postfix) with ESMTP id C9F9A1054FC3; Wed, 20 Nov 2019 13:27:28 +0000 (UTC) From: Kevin Traynor To: dev@dpdk.org, john.mcnamara@intel.com, marko.kovacevic@intel.com Cc: david.marchand@redhat.com, Kevin Traynor Date: Wed, 20 Nov 2019 13:27:13 +0000 Message-Id: <20191120132713.28197-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-MC-Unique: OKiBOpVIPL-WwEWNuLDdBg-1 X-Mimecast-Spam-Score: 0 Subject: [dpdk-dev] [PATCH] doc: add info about codespell config X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Document the config to use codespell with checkpatches.sh. Signed-off-by: Kevin Traynor --- doc/guides/contributing/patches.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 214030346..0f1333471 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -408,6 +408,13 @@ updating the Linux kernel sources. The path to the original Linux script must be set in the environment variable ``DPDK_CHECKPATCH_PATH``. -This, and any other configuration variables required by the development tools, are loaded from the following -files, in order of preference:: + +Spell checking of commonly misspelled words can be enabled by downloading the codespell dictionary:: + + curl -o ~/dictionary.txt https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt + +The path to the downloaded ``dictionary.txt`` must be set in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. + +Environment variables required by the development tools, are loaded from the following files, +in order of preference:: .develconfig