From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id E166E1382C5 for ; Tue, 30 Mar 2021 06:55:52 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 98B9EE086D; Tue, 30 Mar 2021 06:55:51 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 80E6AE086C for ; Tue, 30 Mar 2021 06:55:51 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 7CD8033BE5A for ; Tue, 30 Mar 2021 06:55:50 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 31C68638 for ; Tue, 30 Mar 2021 06:55:49 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1617087204.ce22a0be5e11107c59d6f07fb508b5ff35cdf110.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: eclass-writing/ X-VCS-Repository: proj/devmanual X-VCS-Files: eclass-writing/text.xml X-VCS-Directories: eclass-writing/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: ce22a0be5e11107c59d6f07fb508b5ff35cdf110 X-VCS-Branch: master Date: Tue, 30 Mar 2021 06:55:49 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 28d48b1c-5a4b-4231-af36-0d6520170428 X-Archives-Hash: 98e6781e2231ba4c669d22fb6c2b42c0 commit: ce22a0be5e11107c59d6f07fb508b5ff35cdf110 Author: Sam James gentoo org> AuthorDate: Mon Mar 22 06:19:51 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Tue Mar 30 06:53:24 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ce22a0be eclass-writing: mention pkgcheck usage for checking eclass docs Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 6ac9f0d..288008d 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -151,6 +151,14 @@ multiline freetext, the @CODE tag should be used when necessary to create unformatted code chunks (such as example code) by placing the tag at the beginning and the end.

+ +

+Note that pkgcheck can check for issues in eclass documentation. +You could run e.g. pkgcheck scan -s eclass to check for issues +in the tree or pkgcheck scan --commits to check for issues +in your staged git commits. +

+