From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from wout4-smtp.messagingengine.com (wout4-smtp.messagingengine.com [64.147.123.20]) by mx.groups.io with SMTP id smtpd.web11.15239.1682090113423801155 for ; Fri, 21 Apr 2023 08:15:13 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="signature has expired" header.i=@bsdio.com header.s=fm1 header.b=UAspVRJU; spf=pass (domain: bsdio.com, ip: 64.147.123.20, mailfrom: rebecca@bsdio.com) Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.west.internal (Postfix) with ESMTP id F079232009F6; Fri, 21 Apr 2023 11:15:11 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Fri, 21 Apr 2023 11:15:12 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bsdio.com; h=cc :cc:content-transfer-encoding:content-type:content-type:date :date:from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:sender:subject:subject:to:to; s=fm1; t= 1682090111; x=1682176511; bh=E0wMgAGAWeoWI9YTl7K/h8yoXNY5RADA/CX tnvxLLe4=; b=UAspVRJUNJLWcr8mmnoJL/eWD0gB1/g6/gu//q+yCl6WdEchPNk Ol4BJcJ1GiL6oaGfk2pEk9ne3B/wplPCnfyK5M9fCd/MV4M8BjpoLuOmQkrie+Zj oZ8Tej1IcMBWJcb0w7mBB84jXM/mmJCMHx+gFFnUDsniAd9CtZ7E15JiMEJh2l2i vxBaWXMXf6VshRX9C5vj1rCgXfMv3dWUnUbiywa7C/6IsGWFf8iyXjmtkU6ycNyF TaCGkXJMl+HY50sg5adE3zmRACKqvpztGNljmSAwmIhBgmpULhIJOTXqWFzCEpNn 07Y0dxJvx/CejIc2OfSbBtclaF5TNM+Hktg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:content-type:date:date:feedback-id:feedback-id :from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:sender:subject:subject:to:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm3; t= 1682090111; x=1682176511; bh=E0wMgAGAWeoWI9YTl7K/h8yoXNY5RADA/CX tnvxLLe4=; b=DHoXvACxlWrWESV7tZApEpUWe7T1oi00MopxuWkSDJ2rnmxYmeU OxptB7NusXbZXHl8hNqyvlWyA4tAMlHFA8OHCKupgw+Wo8Lt9kY1CDL3GqWFfaOa upuQyC1UxB00Jap95WsC9q1/cK95gbaEumoAp577GZOaaI6xs7noWW5MLIG/3ybL MXfWha9NkZNZkMfDdcKqO/eG7nIPOEK0qjWGZduK5y9sAc43UdgyyaTI4deUKGTX OLHeJeZZrpgEt+ZzI3fc/M00JnF2kUGwqD9NqzHXFaDDivyMR7reprvdQFzdw+zo qARWiTIZOMQ2eazrwn8VNtS5+RIbgUzhkrg== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvhedrfedtgedgkeegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepkfffgggfuffvvehfhfgjtgfgsehtkeertddtfeejnecuhfhrohhmpeftvggs vggttggrucevrhgrnhcuoehrvggsvggttggrsegsshguihhordgtohhmqeenucggtffrrg htthgvrhhnpeegfeegveduheejgfduffefhfehleehiefghfetvdejvdelhfeukefhhfdv geehveenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpe hrvggsvggttggrsegsshguihhordgtohhm X-ME-Proxy: Feedback-ID: i5b994698:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 21 Apr 2023 11:15:10 -0400 (EDT) Message-ID: <391daf63-b07a-2bff-ad73-7fca2461d1c2@bsdio.com> Date: Fri, 21 Apr 2023 09:15:10 -0600 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.10.0 Subject: Re: [edk2-devel] [PATCH v6 2/2] add ArmCpuInfo EFI application To: Marcin Juszkiewicz , devel@edk2.groups.io, quic_llindhol@quicinc.com Cc: Ard Biesheuvel , Pedro Falcato References: <20230420144423.70726-1-marcin.juszkiewicz@linaro.org> <20230420144423.70726-2-marcin.juszkiewicz@linaro.org> <98e2cf1d-f0df-0975-13e1-05e40760d7c4@bsdio.com> <1bdb2272-b5bc-fa76-9e7f-0be48ba36553@linaro.org> From: "Rebecca Cran" In-Reply-To: <1bdb2272-b5bc-fa76-9e7f-0be48ba36553@linaro.org> Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit On 4/21/23 08:59, Marcin Juszkiewicz wrote: > Thanks for links. Interface for EDK2 CI is not easy for beginners. It really isn't, unfortunately. > Doxygen info is something I probably never wrote so would need to look > at rest of EDK2 code to find out what it is and how to use it. It's pretty straightforward. The format EDK2 uses is: /** Description of the function.   @param FirstParam      Description of FirstParam:                                       Can use multiple lines.   @param SecondParam Description of SecondParam.   @return Explanation of return values - or can use @retval instead.   @retval FirstPossibleReturnValue Can use @retval instead of @return to describe individual values.   @retval SecondPossibleReturnValue Description. **/ > > There is also this: > > > ERROR - EFI coding style error > > ERROR - *Error code: 9001 > > ERROR - *The file headers should follow Doxygen special > > documentation blocks in section 2.3.5 > > ERROR - *file: D:\a\1\s\Build\.pytool\Plugin\EccCheck\ArmPkg > > \Application\ArmCpuInfo\ArmCpuInfo.inf > > ERROR - *Line number: 1 > > ERROR - *Header comment section must have Abstract information. > > Same situation as with Doxygen above. Oh, that's something I've had trouble with in the past. For your patch, it's probably due to the blank line between @file and the description: ## @file # #  Attempt to have AArch64 cpu information. One more thing: copyright lines should ideally have "
" at the end, to indicate to Doxygen to add a line break. -- Rebecca Cran