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=-5.6 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=no 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 BC46CC433E2 for ; Wed, 15 Jul 2020 08:02:42 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9A13F2064C for ; Wed, 15 Jul 2020 08:02:42 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="q2XXH5Fk" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729573AbgGOICk (ORCPT ); Wed, 15 Jul 2020 04:02:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48068 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729001AbgGOICk (ORCPT ); Wed, 15 Jul 2020 04:02:40 -0400 Received: from mail-pl1-x641.google.com (mail-pl1-x641.google.com [IPv6:2607:f8b0:4864:20::641]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 08736C061755 for ; Wed, 15 Jul 2020 01:02:40 -0700 (PDT) Received: by mail-pl1-x641.google.com with SMTP id x8so2055919plm.10 for ; Wed, 15 Jul 2020 01:02:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=28LPiAqo6rn61iySEHGNuvUMSg1fAAzkUJ6/74196es=; b=q2XXH5FkzyM+I/gEOBKmjb1QlV9XBEvY1twWEJnRlidueLWibUqV4QyC45U0hx45ly 5B65hTcRdCLKmk5dGyRrAhGxXZu45q/cxUEg1OZnXhFNjqlQeLCa0L8v0+qgM3pAzS8w vrOcj0bucXfYarPsK80ub8hZCDzExNnRtBjuHrIIo3+iGpAlP2yBP3aYvagvYR5sQuGa Sp2LaNKrb/nr3rWDC5YwdJTBA+mudqKuNCXBrTgI698hxNygOTjLht67saJcsMgbHhUf qS64Lvb4tAmqbBjXokRiscmMcFiPKFGwulfwy2+KmDivNIsetaV1XHX5ljnmo3Z9aSke WYCQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=28LPiAqo6rn61iySEHGNuvUMSg1fAAzkUJ6/74196es=; b=BCvDsrwAeesbnU0qu9CwaNNRlJm+nYCyvXtkx036+BHRKY90gv38RnX7DxECO93bJh om+isltopjdSF2Tn2ilWYsxEhAssrxL8MjiIEeayNG/iyYLjEluff5CcMC1IwW1QiyUq OzzMJQQCKkn1EUteAhmzGraNf2Txk7k/AjHUzGIBicnpN0HaVedFd+DRzNRP4cZ9Q8mr /IRDa+omckhjmAk1Eunoq7VobaEJLFjZzfQZE0UBFA6w7aqLmwlkYgfusBHxR3J0rhoO HBrZ7/+j8MAZzx7KrwwihpqH1zkDjUeu5AxWjOaNyuKMDFfgWkkoTAKVG5V7imzy0BLH 2Upg== X-Gm-Message-State: AOAM530McYzjo9JPnDZfqBqPs4wGRyaPyqNhCDTfNzJxVAiu3KNCijUu dVdi3pIjL9PmsY8JmlWQGd6nvQ== X-Google-Smtp-Source: ABdhPJxedNl8dwWRu2b2ozerCCOLDc/kmjGQO7RexlfDLuupNj0NWkugyMQ8g3x3UE/bPykP1JE0UA== X-Received: by 2002:a17:90b:b0a:: with SMTP id bf10mr8336516pjb.220.1594800159342; Wed, 15 Jul 2020 01:02:39 -0700 (PDT) Received: from localhost ([122.172.34.142]) by smtp.gmail.com with ESMTPSA id x22sm1343745pfr.11.2020.07.15.01.02.38 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 15 Jul 2020 01:02:38 -0700 (PDT) Date: Wed, 15 Jul 2020 13:32:36 +0530 From: Viresh Kumar To: Lee Jones Cc: rjw@rjwysocki.net, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org, Venkatesh Pallipadi , Jun Nakajima , Alexander Clouter Subject: Re: [PATCH 03/13] cpufreq: cpufreq_governor: Demote store_sampling_rate() header to standard comment block Message-ID: <20200715080236.n3gecwhidorn4rqq@vireshk-i7> References: <20200714145049.2496163-1-lee.jones@linaro.org> <20200714145049.2496163-4-lee.jones@linaro.org> <20200715025249.ukoqup4piqiz5lim@vireshk-i7> <20200715064539.GS1398296@dell> <20200715070836.l24lzkb6pgvqj26i@vireshk-i7> <20200715073150.GX1398296@dell> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200715073150.GX1398296@dell> User-Agent: NeoMutt/20180716-391-311a52 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 15-07-20, 08:31, Lee Jones wrote: > I'm not sure what you mean. Kerneldoc headers are designed to be > extracted and converted into mediums which are easy to read/browse. > For example, see the online documentation for 'debug_object_init': > > https://www.kernel.org/doc/html/latest/core-api/debug-objects.html?highlight=debug_object_init#c.debug_object_init > > They are generally meant to be referenced/consumed. There is even a > script provided inside the kernel to find offending instances where > kerneldoc headers are provided, but not *yet* referenced: > > `scripts/find-unused-docs.sh` > > HINT: There are many. > > There *could* be and argument to use kerneldoc *just* so you can use > the kerneldoc checker `scripts/kernel-doc` (which is invoked by W=1 > builds), in order to ensure the parameter descriptions are kept in > check. > > However, in this case, there are no descriptions provided. So, in > reference to my previous question, what are your reasons for wanting > to keep kerneldoc here? I think the code did the right thing by keeping them as kernel doc type comments. What we missed then is getting them used in the *.rst documentation. A simple way of doing that could be just adding this to the cpu-freq rst file, like: -------------------------8<------------------------- Here are the bits from the in-source documentation: .. kernel-doc:: include/linux/cpufreq.h .. kernel-doc:: drivers/cpufreq/cpufreq.c .. kernel-doc:: drivers/cpufreq/freq_table.c .. kernel-doc:: drivers/cpufreq/cpufreq_governor.c -------------------------8<------------------------- This will make the script stop complaining about these. But the layout of things wont' be very nice right now. -- viresh 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=-5.5 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=no 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 6DE80C433E7 for ; Wed, 15 Jul 2020 08:04:09 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 3E59C2065E for ; Wed, 15 Jul 2020 08:04:09 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="GV9C9FZo"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="q2XXH5Fk" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3E59C2065E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References:Message-ID: Subject:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=QFNTCuwoxus8SZLO6LjRR4xQXTKvw4P+mAyqpf7sA/4=; b=GV9C9FZoGH4zmPC0Lq/oC+9p4 biZ3Sgfrm6WejTM1bXc7+kvNHyW7GTGp0hDDlhmUkxEelTugR8HspWYgsuu9Zk9T/1jj0LWW/tOIB Vm5801SP0d5e+l8rIMjaZmvmpM4tq+nrPqYRTUTMIMYMF/O9bj82WEoiQSuxzxpD2rxNytbfDQZl0 IWmNwNSDSFmnH2BErpKtPMSKsa34VRNApnUKq4rg7c9jrY+K0WEmm5Ov6NQBIl86QyA32yPzwcUFR eWxCoOSZemtkLeRGaa1Wu/bXpDPAsv8pfnJKAte4LgznTztVGKSntSAV9yNyBVaPBKYP/EvSWnN+M l/XXpxj6A==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jvcNJ-0008BG-1R; Wed, 15 Jul 2020 08:02:45 +0000 Received: from mail-pl1-x644.google.com ([2607:f8b0:4864:20::644]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jvcNF-0008AB-LG for linux-arm-kernel@lists.infradead.org; Wed, 15 Jul 2020 08:02:42 +0000 Received: by mail-pl1-x644.google.com with SMTP id d1so2062343plr.8 for ; Wed, 15 Jul 2020 01:02:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=28LPiAqo6rn61iySEHGNuvUMSg1fAAzkUJ6/74196es=; b=q2XXH5FkzyM+I/gEOBKmjb1QlV9XBEvY1twWEJnRlidueLWibUqV4QyC45U0hx45ly 5B65hTcRdCLKmk5dGyRrAhGxXZu45q/cxUEg1OZnXhFNjqlQeLCa0L8v0+qgM3pAzS8w vrOcj0bucXfYarPsK80ub8hZCDzExNnRtBjuHrIIo3+iGpAlP2yBP3aYvagvYR5sQuGa Sp2LaNKrb/nr3rWDC5YwdJTBA+mudqKuNCXBrTgI698hxNygOTjLht67saJcsMgbHhUf qS64Lvb4tAmqbBjXokRiscmMcFiPKFGwulfwy2+KmDivNIsetaV1XHX5ljnmo3Z9aSke WYCQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=28LPiAqo6rn61iySEHGNuvUMSg1fAAzkUJ6/74196es=; b=l9Zfhx9n4ArZ1jMR1mN8vGyxoVhh1DR5c1ZxO7G8Bmk6kIOHf0TYgVEydj3Euv1FZ1 aVt1SGY0bvX3c1TdaYerOAyQGOkemv+bWtmJDjgSA6X/fga0CZMWjVO0uiO05OM6AU6Y uqO7uCW5irgLNNcYcWMwKXNBxMiilO2MXS/2fJuGLpl3V6iS5gg5Th1j/uFpF+5zFNh6 mDWZ89UlAmoe1cJX2gUSHsaVDh7xPOYvDTRb7+8xodWFBsXARDQvFucfBK/EI2xxKu67 bziSZB9PSnFMwhCzPAXNvKLquH38OLz+hT51MFvOB0q9AeYQ/TqkxAABmjm5Qj0zlJDH oizw== X-Gm-Message-State: AOAM5319CZagjXtvcoX5NVxhlgI+AngAfO4vJL6F9o8TMTiYDiGx6qWL Bpw6nOXxQcaVyg1C5obJZHTdlA== X-Google-Smtp-Source: ABdhPJxedNl8dwWRu2b2ozerCCOLDc/kmjGQO7RexlfDLuupNj0NWkugyMQ8g3x3UE/bPykP1JE0UA== X-Received: by 2002:a17:90b:b0a:: with SMTP id bf10mr8336516pjb.220.1594800159342; Wed, 15 Jul 2020 01:02:39 -0700 (PDT) Received: from localhost ([122.172.34.142]) by smtp.gmail.com with ESMTPSA id x22sm1343745pfr.11.2020.07.15.01.02.38 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 15 Jul 2020 01:02:38 -0700 (PDT) Date: Wed, 15 Jul 2020 13:32:36 +0530 From: Viresh Kumar To: Lee Jones Subject: Re: [PATCH 03/13] cpufreq: cpufreq_governor: Demote store_sampling_rate() header to standard comment block Message-ID: <20200715080236.n3gecwhidorn4rqq@vireshk-i7> References: <20200714145049.2496163-1-lee.jones@linaro.org> <20200714145049.2496163-4-lee.jones@linaro.org> <20200715025249.ukoqup4piqiz5lim@vireshk-i7> <20200715064539.GS1398296@dell> <20200715070836.l24lzkb6pgvqj26i@vireshk-i7> <20200715073150.GX1398296@dell> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20200715073150.GX1398296@dell> User-Agent: NeoMutt/20180716-391-311a52 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200715_040241_751953_ABD18DFB X-CRM114-Status: GOOD ( 16.16 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Alexander Clouter , linux-pm@vger.kernel.org, rjw@rjwysocki.net, linux-kernel@vger.kernel.org, Jun Nakajima , Venkatesh Pallipadi , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On 15-07-20, 08:31, Lee Jones wrote: > I'm not sure what you mean. Kerneldoc headers are designed to be > extracted and converted into mediums which are easy to read/browse. > For example, see the online documentation for 'debug_object_init': > > https://www.kernel.org/doc/html/latest/core-api/debug-objects.html?highlight=debug_object_init#c.debug_object_init > > They are generally meant to be referenced/consumed. There is even a > script provided inside the kernel to find offending instances where > kerneldoc headers are provided, but not *yet* referenced: > > `scripts/find-unused-docs.sh` > > HINT: There are many. > > There *could* be and argument to use kerneldoc *just* so you can use > the kerneldoc checker `scripts/kernel-doc` (which is invoked by W=1 > builds), in order to ensure the parameter descriptions are kept in > check. > > However, in this case, there are no descriptions provided. So, in > reference to my previous question, what are your reasons for wanting > to keep kerneldoc here? I think the code did the right thing by keeping them as kernel doc type comments. What we missed then is getting them used in the *.rst documentation. A simple way of doing that could be just adding this to the cpu-freq rst file, like: -------------------------8<------------------------- Here are the bits from the in-source documentation: .. kernel-doc:: include/linux/cpufreq.h .. kernel-doc:: drivers/cpufreq/cpufreq.c .. kernel-doc:: drivers/cpufreq/freq_table.c .. kernel-doc:: drivers/cpufreq/cpufreq_governor.c -------------------------8<------------------------- This will make the script stop complaining about these. But the layout of things wont' be very nice right now. -- viresh _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel