From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 780F415ECED; Thu, 11 Jul 2024 13:34:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720704875; cv=none; b=CXqE7o0kkgSgdhHkxLmZNkfdlzS1mEgUW5Cdu5ifbN2bs4KaIy4TMExgHa/31r424AYu9d57siYVcriiGplRfmNXqspoK0LtnjZ6puWaKbM1RvY9iXhvt4z4UzOPgMExGikstrX6KS9c6cEe+qcLiCzaqR4l/fZRp6JU754V86I= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720704875; c=relaxed/simple; bh=2245hG+1Ai1cZny9nsPPBR8t+Q8qNnh9+uiqqQ1DY0c=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=B2SmVqmCVeiCgy2UR1cY+igp4D/pSGak41zSfZO6Dr11Js5eyfeZjEt8B+JrPAZVScpNMDmQyx0eqtqLw4ICEZLvyk1rpgJsanj0908/Yc+ttPtGqpKQtoifPclDg8YrWj9PgasrLAw9q0CUBi/oAKrz2+oNtoLuuCphmN4rMCc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=sJCMyte9; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="sJCMyte9" Received: by smtp.kernel.org (Postfix) with ESMTPSA id E49C3C32786; Thu, 11 Jul 2024 13:34:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1720704874; bh=2245hG+1Ai1cZny9nsPPBR8t+Q8qNnh9+uiqqQ1DY0c=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=sJCMyte9hfIJGg1Y2Ex3vGQBwOzi5YhtSoMLqo82KRwpSJz99+9DAuvs6dQ0rJkOZ DU++zPfDQKVMQ+0kexZ9uParR+Ligk47q5JUG+8SeI/HNS2kAAk6ZqlIPwMU5rQi4I eWkosPCP/5eNGevePrua9M3qxxGuycxgVkeWSdlF1zusEFlGgYFL0ThZTBuYM2/BSR d0ChOf5zLEuR53NHciVn2yh66iJMhqTOZZkmNMXMj8P9slRoEAdt1DLP+gZ7DULk/f 4dPEHyD6Q27bF7QZjsyQo1FowlydNcco2WJ+sk8199GJuznccJ6axC16ONEo3cAvdW RSopsS0nF7dDg== Date: Thu, 11 Jul 2024 14:34:30 +0100 From: Simon Horman To: Jeff Johnson Cc: Ilya Dryomov , Xiubo Li , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , ceph-devel@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH net-next 1/2] libceph: suppress crush_choose_indep() kernel-doc warnings Message-ID: <20240711133430.GE8788@kernel.org> References: <20240710-kd-crush_choose_indep-v1-0-fe2b85f322c6@quicinc.com> <20240710-kd-crush_choose_indep-v1-1-fe2b85f322c6@quicinc.com> Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20240710-kd-crush_choose_indep-v1-1-fe2b85f322c6@quicinc.com> On Wed, Jul 10, 2024 at 11:10:03AM -0700, Jeff Johnson wrote: > Currently, when built with "make W=1", the following warnings are > generated: > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'map' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'work' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'bucket' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'weight' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'weight_max' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'x' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'left' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'numrep' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'type' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'out' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'outpos' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'tries' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'recurse_tries' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'recurse_to_leaf' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'out2' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'parent_r' not described in 'crush_choose_indep' > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'choose_args' not described in 'crush_choose_indep' > > These warnings are generated because the prologue comment for > crush_choose_indep() uses the kernel-doc prefix, but the actual > comment is a very brief description that is not in kernel-doc > format. Since this is a static function there is no need to fully > document the function, so replace the kernel-doc comment prefix with a > standard comment prefix to remove these warnings. > > Signed-off-by: Jeff Johnson Reviewed-by: Simon Horman