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=-16.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=unavailable 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 257EEC433F5 for ; Thu, 16 Sep 2021 10:58:04 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0E78161212 for ; Thu, 16 Sep 2021 10:58:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237266AbhIPK7W (ORCPT ); Thu, 16 Sep 2021 06:59:22 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55176 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237558AbhIPK7O (ORCPT ); Thu, 16 Sep 2021 06:59:14 -0400 Received: from mail-wm1-x32b.google.com (mail-wm1-x32b.google.com [IPv6:2a00:1450:4864:20::32b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0A763C061574 for ; Thu, 16 Sep 2021 03:57:54 -0700 (PDT) Received: by mail-wm1-x32b.google.com with SMTP id n7-20020a05600c3b8700b002f8ca941d89so4186553wms.2 for ; Thu, 16 Sep 2021 03:57:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=isovalent-com.20150623.gappssmtp.com; s=20150623; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=gvciQBRjdKJ+epYnhvh12uEei/mAg84fmaGrBTbZwcI=; b=sl7KqI7lXKNlZd5Y2NBZmthXWE0BxN9jJBaEcMPqwByQ+vRVxh1sDf+na7WazEiqYF jr/fIpeNebDrVKtnJEzpukm1192/nx13KL3YaEhtn8FY5dDxR3bMmxVu4KQvOJpBNEyM ErzJ70IPQT/l3oFI/qqAQtuzq1cn8Pi5/J8rkrbDFVMI6EmD3ic2+pSiYiXd2P/X9i1f HOF5mH+/dxe9BH1qqdHBCn5z8qYH/jKb3Erp/2kdORiF8ny0FjMm4EaTbVt0gBvMgfl1 eISpp3j9juqaDsZ1zpIFvMSRbKPFZqPk5TwEAV7j8UaunWJyoeUaSCUGBPQj+7TsDr8B pKTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=gvciQBRjdKJ+epYnhvh12uEei/mAg84fmaGrBTbZwcI=; b=P4VB2cuSq1ApHRinY3IveX57ooW6lx+jJwXZAgS2fWhk7awVrdWDWX/D7wCpm9p7nK 0IvZ1UMPaxTH3vtmOGilnMz0zSCI1aFC85Tybay7uvDfc4Qyijz+RL+T9ra7OASalSIz /TyZGRfCa74naDHN2vlPsvI+bQFBqchrqS2UvIEkpbvCyGoisD662g9TeOCcXPSrdf3G RXYCjRtmKShG7Qotpt1bmwicb0ouTjbMFYhtBt3SZLe23p1n0/PYdhYhInEpr8RC54qn uaVUI2V88fD8ZH0RkkvAJEXzlHWYox9+eEdkPIYsas+x6zy146sbDnFbefLRQdIGJ+x0 tnPA== X-Gm-Message-State: AOAM532BNNgL/7YRMKbnheJ7/JkeFpLqQQLEOxNmWqq2VO/Wj4hrZ6YP rdpAUZD12n2asZTyfqYDW5edJg== X-Google-Smtp-Source: ABdhPJwy1PAeu6n9GWTT6elODrsFuP2EWjwg7KZZ18iKsZn2ewdDTJg2LA13SB/rsk3pKcvLU7haSg== X-Received: by 2002:a7b:cd0f:: with SMTP id f15mr4416172wmj.173.1631789872597; Thu, 16 Sep 2021 03:57:52 -0700 (PDT) Received: from [192.168.1.8] ([149.86.87.95]) by smtp.gmail.com with ESMTPSA id b16sm3067515wrp.82.2021.09.16.03.57.51 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 16 Sep 2021 03:57:52 -0700 (PDT) Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Jonathan Corbet , "David S. Miller" , Alexei Starovoitov , Andrii Nakryiko , Daniel Borkmann , David Beckett , Jakub Kicinski , John Fastabend , KP Singh , Martin KaFai Lau , Shuah Khan , Song Liu , Yonghong Song , bpf@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, netdev@vger.kernel.org References: <20210916124930.7ae3b722@coco.lan> From: Quentin Monnet Message-ID: <33d66a49-2fc0-57a1-c1e5-34e932bcc237@isovalent.com> Date: Thu, 16 Sep 2021 11:57:51 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.14.0 MIME-Version: 1.0 In-Reply-To: <20210916124930.7ae3b722@coco.lan> Content-Type: text/plain; charset=utf-8 Content-Language: en-GB Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 2021-09-16 12:49 UTC+0200 ~ Mauro Carvalho Chehab > Hi Quentin, > > Em Thu, 16 Sep 2021 10:43:45 +0100 > Quentin Monnet escreveu: > >> 2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab >> >>> The file name: Documentation/bpftool-prog.rst >>> should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst. >>> >>> Update its cross-reference accordingly. >>> >>> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion") >>> Fixes: ff69c21a85a4 ("tools: bpftool: add documentation") >> >> Hi, >> How is this a fix for the commit that added the documentation in bpftool? >> >>> Signed-off-by: Mauro Carvalho Chehab >>> --- >>> tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +- >>> 1 file changed, 1 insertion(+), 1 deletion(-) >>> >>> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py >>> index be54b7335a76..27a2c369a798 100755 >>> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py >>> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py >>> @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor): >>> """ >>> An extractor for bpftool-prog.rst. >>> """ >>> - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst') >>> + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst') >>> >>> def get_attach_types(self): >>> return self.get_rst_list('ATTACH_TYPE') >>> >> >> No I don't believe it should. BPFTOOL_DIR already contains >> 'tools/bpf/bpftool' and the os.path.join() concatenates the two path >> fragments. >> >> Where is this suggestion coming from? Did you face an issue with the script? > > No, I didn't face any issues with this script. > > The suggestion cames from the script at: > > ./scripts/documentation-file-ref-check > > which is meant to discover broken doc references. > > Such script has already a rule to handle stuff under tools/: > > # Accept relative Documentation patches for tools/ > if ($f =~ m/tools/) { > my $path = $f; > $path =~ s,(.*)/.*,$1,; > next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref")); > } > > but it seems it needs a fixup in order for it to stop reporting issues > at test_bpftool_synctypes.py: > > $ ./scripts/documentation-file-ref-check > ... > tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-prog.rst > tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-map.rst > tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-cgroup.rst Oh, I see, thanks for explaining. I didn't know this script would catch the paths in bpftool's test file. > > I'll drop the patches touching it for a next version, probably > adding a fix for such script. > > Thanks, > Mauro > Sounds good to me, thanks a lot! Quentin