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 12AE342D12; Wed, 21 Jun 2023 10:10:21 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 95A36406BC; Wed, 21 Jun 2023 10:10:20 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 1D1304068E for ; Wed, 21 Jun 2023 10:10:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1687335018; 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=M45EHiSw8+cidgp0016TuPFNuQzz/tSDtTLmjDrUnow=; b=jVA+miXF/AQhUFx3NVp+KIi+esXWbSq5mI0VNuAusa216tFtSHR1VlR4nsQXWGtqSr3pM9 ziDzK/8dQKGdVTPYSBgUVBy5hgrv/EA5KuXGa8c8t9OcZc1Pn4M9DKd/gJqEFqyDL2B6EG LD6Usr2Ut+eRKcq1S09aqugvI1SBnGk= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-519-MouPziz2NM2OaDQ2pmDbzw-1; Wed, 21 Jun 2023 04:10:15 -0400 X-MC-Unique: MouPziz2NM2OaDQ2pmDbzw-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 23774104458C; Wed, 21 Jun 2023 08:10:15 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.224.210]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6CCDA1400C34; Wed, 21 Jun 2023 08:10:14 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: thomas@monjalon.net Subject: [PATCH] devtools: forbid reference to doc.dpdk.org/guides Date: Wed, 21 Jun 2023 10:09:20 +0200 Message-Id: <20230621080920.861541-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true 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 Putting links to doc.dpdk.org/guides in our documentation should be avoided because it makes the documentation point at the current state of the DPDK tree regardless of the version it is generated against. Note: it should be acceptable to mention previous versions of DPDK (like in old release notes), so the pattern has an explicit trailing /. Signed-off-by: David Marchand --- devtools/checkpatches.sh | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 15d5d67094..39235da985 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -175,6 +175,14 @@ check_forbidden_additions() { # -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ "$1" || res=1 + # don't use external URL in documentation, prefer internal references + awk -v FOLDERS='doc' \ + -v EXPRESSIONS='//doc.dpdk.org/guides/' \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using explicit URL to doc.dpdk.org, prefer :ref: or :doc:' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + # '// XXX is not set' must be preferred over '#undef XXX' awk -v FOLDERS='config/rte_config.h' \ -v EXPRESSIONS='#undef' \ -- 2.40.1