From patchwork Thu Nov 28 04:26:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen-Yu Tsai X-Patchwork-Id: 846202 Received: from mail-pf1-f178.google.com (mail-pf1-f178.google.com [209.85.210.178]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C298B13665A for ; Thu, 28 Nov 2024 04:26:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.178 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732768000; cv=none; b=R2GOO6KY3uSVYDw2c3oNxnpN5FguVaecPbGOlr9naUhLDaEj8UNEvLDVagHg5OFRdoSHUVL3QA9YUVMV0mM1BIYYGLLMgXYQ0wH5O1LaZOaHcSwiARYjscLZts8e3kfxk89eTINVhl1/JpfIUmoY6wk7CORJHqLfWFv7iWzFSE4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732768000; c=relaxed/simple; bh=SQ5HTme1SLECGbVCaGoPHfecPrbsN1EOEWv6CHUAVP0=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=sAfQUGD/ENYpWvLLAhDGU+2o86HH4L21WCi9r+uu+TsWoxny4KKMPp30CV3beCU9BZC6SdzFpoGGoCD5Uj9PucTx1OJHxGOqWccWmFETlawfSuhuIeUs7lXiBSAPu3TLFIFAnwlb+9D9zo4WSIgV79r9IPHY9hG0We5sar+d9XU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=CKJNNjGo; arc=none smtp.client-ip=209.85.210.178 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="CKJNNjGo" Received: by mail-pf1-f178.google.com with SMTP id d2e1a72fcca58-7251abe0e69so439019b3a.0 for ; Wed, 27 Nov 2024 20:26:38 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1732767998; x=1733372798; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=yyk7Iou25uRg3TCJZa+tSFUnZozoGmQKQzSvVwcJ1m4=; b=CKJNNjGoB9nwkV51z6xz+dTyhdEk8nnBvfC4B0VL+W608Iqw9i0VUSAj9R1JYjCwBm BWyhJK189hq3Sg+DDo46Q/IkkxmhhUOLHGK/W+IfUNCjUDKqGSiFuo4riaROENZRoKo4 EGmNhP1t1xLCk/OAp5JHt8kILqThOL5Ee1noQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732767998; x=1733372798; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=yyk7Iou25uRg3TCJZa+tSFUnZozoGmQKQzSvVwcJ1m4=; b=Uvzk8LAXbTxhP8RQEZ5ZgC04YJt+rJPZTfSiwcUvAcJs4jOUrIByQiXsJVvp03HSdH p58t8dRm8yt5IMvlAOGBuYbY1yMq1XIlGvIGLtyDKtyUfjJWtElIQ72Kf9iGl+uGiGQm nAftOGAE2YkMO3pFX18CX5jlm0X1nGBlmzY3yStoR2b0ad9XPw32tSknrx7W8hQyQINO 0QMQu4Adq/PXFzRm+u8efWJW+AAIrDexYE2B0va3mnIq4Wc1olbzqyRyx8oWlfjFClg0 UogO/0gpFavSFxvDAc/nexxIbMaz7xK4eoI+/oK0Qtdx0WPBqfAizQO6E8TuGcj3h13a IeYg== X-Forwarded-Encrypted: i=1; AJvYcCXtj+iKNR+76RD/gDLMNzROTXbYTOzO1T85ABoUoe+0uEDWEc7nYZsrT9261/c1D0fpRshAs2q8boU=@vger.kernel.org X-Gm-Message-State: AOJu0YzLbr/y8ZAXt6KmCvKlCzU+4jg+XvaNhOpJFMb/lwdEk5NSi0xe x4CxZ6c8s4kmDb1ND0ZZpBCXaP0vP3RPRn/eLjHPqNSrxscCxwYKg6tFRjjTVnPWRym5UYqb8tk = X-Gm-Gg: ASbGncv25ypLu1Iv0gtPxc7BJiUpH8MVmPFYThalzy3tf5bu4oHNs7+nUTu0bi0VX5j PiX1WY9CfeHl26xIQopH/TwNC6oh8XxcC28Vk+bo9A3vwz+UTLDuRMSEt+JlfUcsYfOp9pE+Jhc 7SLVtwi0kHIw+/b8UMHodGJXkuveM8jzGc+nhk+X5qwsjlizHPTo3LM217Nd0mwOYYTAqLeo7us l73Ba5NRLZ+RJhFeOoMjUDyR/jJmETpInTQs1WI+MOcRbtV273R+cnQx4lGNBcPI/5d X-Google-Smtp-Source: AGHT+IHeZNuSWgVtWvTDokMDlIw4ArRKKjwJZ33jbZfsR02Ur3asny/Ji3uLw2rlY2Y0R8BhHPJDpA== X-Received: by 2002:a05:6a00:3d0e:b0:725:14fd:f62c with SMTP id d2e1a72fcca58-72530078935mr6645836b3a.15.1732767997932; Wed, 27 Nov 2024 20:26:37 -0800 (PST) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:2db5:507b:eafb:b616]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-72541849509sm439133b3a.197.2024.11.27.20.26.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 27 Nov 2024 20:26:37 -0800 (PST) From: Chen-Yu Tsai To: Rob Herring , Saravana Kannan , Wolfram Sang Cc: Chen-Yu Tsai , devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Andy Shevchenko , linux-i2c@vger.kernel.org, kernel test robot Subject: [PATCH] of: base: Document prefix argument for of_get_next_child_with_prefix() Date: Thu, 28 Nov 2024 12:26:30 +0800 Message-ID: <20241128042632.231308-1-wenst@chromium.org> X-Mailer: git-send-email 2.47.0.338.g60cca15819-goog Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 When of_get_next_child_with_prefix() was added, the prefix argument was left undocumented. This caused a new warning to be generated during the kerneldoc build process: drivers/of/base.c:661: warning: Function parameter or struct member 'prefix' not described in 'of_get_next_child_with_prefix' Properly document the argument to fix this. Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202411280010.KGSDBOUE-lkp@intel.com/ Fixes: 1fcc67e3a354 ("of: base: Add for_each_child_of_node_with_prefix()") Signed-off-by: Chen-Yu Tsai --- As requested. I assume Rob would give an ack for this to go through the I2C tree since the offending commit is there as well. I also put this patch on git.kernel.org hoping that it gets some bot coverage soon: http://git.kernel.org/wens/h/of_get_next_child_with_prefix-kdoc-fix I guess I should have put the original patches on a separate branch on git.kernel.org for bots to run earlier. I'm sorry for not catching this sooner. drivers/of/base.c | 1 + 1 file changed, 1 insertion(+) diff --git a/drivers/of/base.c b/drivers/of/base.c index 4cba021c89d3..7dc394255a0a 100644 --- a/drivers/of/base.c +++ b/drivers/of/base.c @@ -648,6 +648,7 @@ EXPORT_SYMBOL(of_get_next_child); * of_get_next_child_with_prefix - Find the next child node with prefix * @node: parent node * @prev: previous child of the parent node, or NULL to get first + * @prefix: prefix that the node name should have * * This function is like of_get_next_child(), except that it automatically * skips any nodes whose name doesn't have the given prefix.