From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-23.3 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_IN_DEF_DKIM_WL autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6F14AC47082 for ; Sat, 5 Jun 2021 15:44:10 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 572AA60FE4 for ; Sat, 5 Jun 2021 15:44:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230039AbhFEPp5 (ORCPT ); Sat, 5 Jun 2021 11:45:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38660 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229930AbhFEPp4 (ORCPT ); Sat, 5 Jun 2021 11:45:56 -0400 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F34C8C061766 for ; Sat, 5 Jun 2021 08:44:07 -0700 (PDT) Received: by mail-wr1-x436.google.com with SMTP id u7so6851069wrs.10 for ; Sat, 05 Jun 2021 08:44:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=IJfhHkzB6JU+XSlwyc8dKxQocbIwcKlTcjVegE04Z64=; b=Xp/1GC/FizBJ465G6thyi4L+RqrwjNC8GOq/rM9CqamSQrPTQLkyAMkSFIGnoi0OjN 0j6RsSfS8Bj/WOVdKBAONX6p99rs4VJQ6ihUrudGARIfEjR/KmCff4kGCbsaIiOZN+hx AqjZKcRbIdaoILq0t1gmrruOPTMNaKKjXhOikzWG9amOWQohK7oMKdoDEeN3F2lBXEGV RpfjUJA3SFvVcEhLg2V/OplRu7OQQihUWImlochEKbOdZ45dTloa4D8WE5xZYKqI6PML 9O/FgIPfPpVngvfS7J7KavosG/TqXxVLnqWCnvu5d5Jo5H1vE5Q723FYHNvrJPS4mfRU bxOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=IJfhHkzB6JU+XSlwyc8dKxQocbIwcKlTcjVegE04Z64=; b=sZwPbN6nRe0lLaKv6ILk/jIvi/0hL13x9UbcUp/joF/ujqrQ0HlLe3CTKl/DfBO48e QoFysaJGtSidvB+/swigvA/tfkikmHU1rvtGLMMrWaF+Ls5NiuwFHyQpIZporngMh6dN igb2bK2JhA7ZGbbYGUQfVt00piSc3g8y27pUbU7cmvBATzwYg34tnPwz9IQQUp30QQoy vNYglhRQwpMZHt6oZ+9AmMEyujt8UkZOX++MDOOfzX+8zZrG/IBZ+a+wpus0vRVj2nGn RlHE5ICmr0i8kL3d9VnpcVZPLgszmO7eVX8FkXFJ0eCbiFaLY4sINk/xb/RXmFCSGXrk muzA== X-Gm-Message-State: AOAM533LEWuGhnLRbVCEu5Lo4t6eET0b0Ub03GkbNtbM9mis6m7K89w+ LEhzAM3DvEyZkF1gPt/ZjqXe+L6Ouo6ZAKduaPjNrw== X-Google-Smtp-Source: ABdhPJwkZ1dqyT+ax8qJeKImVdGAV/+mHCCZ4avCc/FU0YlPfuEUQMrUgamyR3aqnG/mvk/wbaP2vkZAOVfK/3Zz958= X-Received: by 2002:adf:e58d:: with SMTP id l13mr8823026wrm.369.1622907846460; Sat, 05 Jun 2021 08:44:06 -0700 (PDT) MIME-Version: 1.0 References: <63fe86c8de5cced00a1bb5d18d6c7f087268565a.1622898327.git.mchehab+huawei@kernel.org> In-Reply-To: <63fe86c8de5cced00a1bb5d18d6c7f087268565a.1622898327.git.mchehab+huawei@kernel.org> From: David Gow Date: Sat, 5 Jun 2021 23:43:55 +0800 Message-ID: Subject: Re: [PATCH 13/34] docs: dev-tools: testing-overview.rst: avoid using ReSt :doc:`foo` markup To: Mauro Carvalho Chehab Cc: Jonathan Corbet , Linux Doc Mailing List , Daniel Latypov , Marco Elver , Linux Kernel Mailing List Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Sat, Jun 5, 2021 at 9:18 PM Mauro Carvalho Chehab wrote: > > The :doc:`foo` tag is auto-generated via automarkup.py. > So, use the filename at the sources, instead of :doc:`foo`. > > Signed-off-by: Mauro Carvalho Chehab > --- Hmm... I'd originally wanted this to read more like the name of the tool than the path to the doc file, but given the :doc: prefix and backticks are equally ugly, and no less confusing to the plain-text reader than the filename, I'm happy to have this changed. Particularly if we're standardising on this across the kernel documentation. Reviewed-by: David Gow -- David > Documentation/dev-tools/testing-overview.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > diff --git a/Documentation/dev-tools/testing-overview.rst b/Documentation/dev-tools/testing-overview.rst > index b5b46709969c..65feb81edb14 100644 > --- a/Documentation/dev-tools/testing-overview.rst > +++ b/Documentation/dev-tools/testing-overview.rst > @@ -71,15 +71,15 @@ can be used to verify that a test is executing particular functions or lines > of code. This is useful for determining how much of the kernel is being tested, > and for finding corner-cases which are not covered by the appropriate test. > > -:doc:`gcov` is GCC's coverage testing tool, which can be used with the kernel > -to get global or per-module coverage. Unlike KCOV, it does not record per-task > -coverage. Coverage data can be read from debugfs, and interpreted using the > -usual gcov tooling. > +Documentation/dev-tools/gcov.rst is GCC's coverage testing tool, which can be > +used with the kernel to get global or per-module coverage. Unlike KCOV, it > +does not record per-task coverage. Coverage data can be read from debugfs, > +and interpreted using the usual gcov tooling. > > -:doc:`kcov` is a feature which can be built in to the kernel to allow > -capturing coverage on a per-task level. It's therefore useful for fuzzing and > -other situations where information about code executed during, for example, a > -single syscall is useful. > +Documentation/dev-tools/kcov.rst is a feature which can be built in to the > +kernel to allow capturing coverage on a per-task level. It's therefore useful > +for fuzzing and other situations where information about code executed during, > +for example, a single syscall is useful. > > > Dynamic Analysis Tools > -- > 2.31.1 >