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 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C21B0C54EE9 for ; Tue, 6 Sep 2022 19:53:01 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id AD20010EA6C; Tue, 6 Sep 2022 19:52:46 +0000 (UTC) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by gabe.freedesktop.org (Postfix) with ESMTPS id EAC9810EA65; Tue, 6 Sep 2022 19:52:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1662493955; x=1694029955; h=date:from:to:cc:subject:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=0JkPYEHioOtGLJAxsT5kA+8eXjUWG3XSjrJRIH80fII=; b=Uf2BZRb+zdrPjdWwtcIjb4pA3E5yuykRoNit+KoZoJHytQEzg+rd5fHu 5XdirDxoWZuJHfAiuUhfAGEK0/zn82tT4MhBzGxc8ehZJ6nyxDhPpaokE g9DUW7SqnlGZxvfqmCVOCrYDrcP62mr24uH7HTsd6LqulrpQYSmvNzXH2 tZw8Pb/+QpsOvyiIcZ6RUBks/cGvNak6juzHXQGk0sZHBh4ceEFCskasF fdNG1mwHaA5YG3w7cgezM5g9BfAdJgY3lSwo0JbsQHVMdbTdCnHVlwwVm RoM3Mvt44E2OqgWoIEMPQM07hYIyLgFYLYpaYMSy9OTb5Vdw6wBVG9Gq/ g==; X-IronPort-AV: E=McAfee;i="6500,9779,10462"; a="360637568" X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="360637568" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Sep 2022 12:52:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="717837480" Received: from linux.intel.com ([10.54.29.200]) by fmsmga002.fm.intel.com with ESMTP; 06 Sep 2022 12:52:32 -0700 Received: from maurocar-mobl2 (maurocar-mobl2.ger.corp.intel.com [10.252.44.186]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by linux.intel.com (Postfix) with ESMTPS id CA236580583; Tue, 6 Sep 2022 12:52:30 -0700 (PDT) Date: Tue, 6 Sep 2022 21:17:47 +0200 From: Mauro Carvalho Chehab To: Rodrigo Vivi Subject: Re: [Intel-gfx] [PATCH v2 18/39] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc Message-ID: <20220906211740.6b92f23d@maurocar-mobl2> In-Reply-To: References: X-Mailer: Claws Mail 4.1.0 (GTK 3.24.34; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: David Airlie , intel-gfx@lists.freedesktop.org, Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" On Tue, 9 Aug 2022 05:55:10 -0400 Rodrigo Vivi wrote: > On Wed, Jul 13, 2022 at 09:12:06AM +0100, Mauro Carvalho Chehab wrote: > > Preserving ascii artwork on kernel-docs is tricky, as it needs > > to respect both the Sphinx rules and be properly parsed by > > kernel-doc script. > > > > The Sphinx syntax require code-blocks, which is: > > > > :: > > > > followed by a blank line and indented lines. > > > > But kernel-doc only works fine if the first and the last line > > are indented with the same amount of spaces. > > > > Also, a "\" at the end means that the next line should be merged > > with the first one. > > my first reaction was: "do we really need those new empty ( ) blocks?" > > Then I read this ;) Yeah, it is tricky to get it right, due to kernel-doc + Sphinx here. Also, I bet that this would be needed even for ReST files with C code on it, as it is likely the C domain encoding at Sphinx that handles continuation lines with "\" at the end... > > Reviewed-by: Rodrigo Vivi > > > > > Change the ascii artwork to be on code-blocks, starting all > > lines at the same characters and not ending with a backslash. > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > > > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. > > See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/ > > > > drivers/gpu/drm/i915/intel_pm.c | 33 ++++++++++++++++++--------------- > > 1 file changed, 18 insertions(+), 15 deletions(-) > > > > diff --git a/drivers/gpu/drm/i915/intel_pm.c b/drivers/gpu/drm/i915/intel_pm.c > > index f06babdb3a8c..d3393752b04b 100644 > > --- a/drivers/gpu/drm/i915/intel_pm.c > > +++ b/drivers/gpu/drm/i915/intel_pm.c > > @@ -684,18 +684,20 @@ static const struct intel_watermark_params i845_wm_info = { > > * FIFO is relatively small compared to the amount of data > > * fetched. > > * > > - * The FIFO level vs. time graph might look something like: > > + * The FIFO level vs. time graph might look something like:: > > * > > - * |\ |\ > > - * | \ | \ > > - * __---__---__ (- plane active, _ blanking) > > - * -> time > > + * ^ > > + * | |\ |\ ( ) > > + * | | \ | \ ( ) > > + * | __---__---__ (- plane active, _ blanking) > > + * +-------------------> time > > * > > - * or perhaps like this: > > + * or perhaps like this:: > > * > > - * |\|\ |\|\ > > - * __----__----__ (- plane active, _ blanking) > > - * -> time > > + * ^ > > + * | |\|\ |\|\ ( ) > > + * | __----__----__ (- plane active, _ blanking) > > + * +-------------------> time > > * > > * Returns: > > * The watermark in bytes > > @@ -731,13 +733,14 @@ static unsigned int intel_wm_method1(unsigned int pixel_rate, > > * FIFO is relatively large compared to the amount of data > > * fetched. > > * > > - * The FIFO level vs. time graph might look something like: > > + * The FIFO level vs. time graph might look something like:: > > * > > - * |\___ |\___ > > - * | \___ | \___ > > - * | \ | \ > > - * __ --__--__--__--__--__--__ (- plane active, _ blanking) > > - * -> time > > + * ^ > > + * | |\___ |\___ ( ) > > + * | | \___ | \___ ( ) > > + * | | \ | \ ( ) > > + * | __ --__--__--__--__--__--__ (- plane active, _ blanking) > > + * +---------------------------------> time > > * > > * Returns: > > * The watermark in bytes > > -- > > 2.36.1 > > 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 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 587ADECAAA1 for ; Tue, 6 Sep 2022 19:59:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230273AbiIFT7z (ORCPT ); Tue, 6 Sep 2022 15:59:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57264 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231336AbiIFT6w (ORCPT ); Tue, 6 Sep 2022 15:58:52 -0400 Received: from mga06.intel.com (mga06b.intel.com [134.134.136.31]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AD7E299B5C for ; Tue, 6 Sep 2022 12:55:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1662494127; x=1694030127; h=date:from:to:cc:subject:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=0JkPYEHioOtGLJAxsT5kA+8eXjUWG3XSjrJRIH80fII=; b=P7dcf5quFENIUpWjL/MWWo/QEnubmxU37bvwqPdL/mRJjNMjFoYy+fvs Cq/Pwhw2UhLPXmq30Hi/4V/iPMARXg3Qb2RG/fScJPQcbjWYXzftHZrxI MrGM32sJxrfBmgyWKuK7ok84Nl0y3jfjLwwIHA9WAGX1jfMW8lCneWAWI BQ55rfg+uPg9Et8zk4bL08Yxn3uWClmG9cbt5iUM0fXXNWwqaA2mfV6D1 U5a6gQTL5R/vhlRAJZRqR2rmcKkFav7hVf7i3rDLnAqjSRrVFlKfo8XiY YuLV2iOlCO+3s6HaoHNSzTPR76cRgv2MJh+OITESCPvHXz7Vkye8kUtrx A==; X-IronPort-AV: E=McAfee;i="6500,9779,10462"; a="358406146" X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="358406146" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Sep 2022 12:52:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="717837480" Received: from linux.intel.com ([10.54.29.200]) by fmsmga002.fm.intel.com with ESMTP; 06 Sep 2022 12:52:32 -0700 Received: from maurocar-mobl2 (maurocar-mobl2.ger.corp.intel.com [10.252.44.186]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by linux.intel.com (Postfix) with ESMTPS id CA236580583; Tue, 6 Sep 2022 12:52:30 -0700 (PDT) Date: Tue, 6 Sep 2022 21:17:47 +0200 From: Mauro Carvalho Chehab To: Rodrigo Vivi Cc: Mauro Carvalho Chehab , David Airlie , intel-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org Subject: Re: [Intel-gfx] [PATCH v2 18/39] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc Message-ID: <20220906211740.6b92f23d@maurocar-mobl2> In-Reply-To: References: X-Mailer: Claws Mail 4.1.0 (GTK 3.24.34; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Tue, 9 Aug 2022 05:55:10 -0400 Rodrigo Vivi wrote: > On Wed, Jul 13, 2022 at 09:12:06AM +0100, Mauro Carvalho Chehab wrote: > > Preserving ascii artwork on kernel-docs is tricky, as it needs > > to respect both the Sphinx rules and be properly parsed by > > kernel-doc script. > > > > The Sphinx syntax require code-blocks, which is: > > > > :: > > > > followed by a blank line and indented lines. > > > > But kernel-doc only works fine if the first and the last line > > are indented with the same amount of spaces. > > > > Also, a "\" at the end means that the next line should be merged > > with the first one. > > my first reaction was: "do we really need those new empty ( ) blocks?" > > Then I read this ;) Yeah, it is tricky to get it right, due to kernel-doc + Sphinx here. Also, I bet that this would be needed even for ReST files with C code on it, as it is likely the C domain encoding at Sphinx that handles continuation lines with "\" at the end... > > Reviewed-by: Rodrigo Vivi > > > > > Change the ascii artwork to be on code-blocks, starting all > > lines at the same characters and not ending with a backslash. > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > > > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. > > See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/ > > > > drivers/gpu/drm/i915/intel_pm.c | 33 ++++++++++++++++++--------------- > > 1 file changed, 18 insertions(+), 15 deletions(-) > > > > diff --git a/drivers/gpu/drm/i915/intel_pm.c b/drivers/gpu/drm/i915/intel_pm.c > > index f06babdb3a8c..d3393752b04b 100644 > > --- a/drivers/gpu/drm/i915/intel_pm.c > > +++ b/drivers/gpu/drm/i915/intel_pm.c > > @@ -684,18 +684,20 @@ static const struct intel_watermark_params i845_wm_info = { > > * FIFO is relatively small compared to the amount of data > > * fetched. > > * > > - * The FIFO level vs. time graph might look something like: > > + * The FIFO level vs. time graph might look something like:: > > * > > - * |\ |\ > > - * | \ | \ > > - * __---__---__ (- plane active, _ blanking) > > - * -> time > > + * ^ > > + * | |\ |\ ( ) > > + * | | \ | \ ( ) > > + * | __---__---__ (- plane active, _ blanking) > > + * +-------------------> time > > * > > - * or perhaps like this: > > + * or perhaps like this:: > > * > > - * |\|\ |\|\ > > - * __----__----__ (- plane active, _ blanking) > > - * -> time > > + * ^ > > + * | |\|\ |\|\ ( ) > > + * | __----__----__ (- plane active, _ blanking) > > + * +-------------------> time > > * > > * Returns: > > * The watermark in bytes > > @@ -731,13 +733,14 @@ static unsigned int intel_wm_method1(unsigned int pixel_rate, > > * FIFO is relatively large compared to the amount of data > > * fetched. > > * > > - * The FIFO level vs. time graph might look something like: > > + * The FIFO level vs. time graph might look something like:: > > * > > - * |\___ |\___ > > - * | \___ | \___ > > - * | \ | \ > > - * __ --__--__--__--__--__--__ (- plane active, _ blanking) > > - * -> time > > + * ^ > > + * | |\___ |\___ ( ) > > + * | | \___ | \___ ( ) > > + * | | \ | \ ( ) > > + * | __ --__--__--__--__--__--__ (- plane active, _ blanking) > > + * +---------------------------------> time > > * > > * Returns: > > * The watermark in bytes > > -- > > 2.36.1 > >