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 mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5905CC433F5 for ; Tue, 9 Nov 2021 08:52:34 +0000 (UTC) Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B6C3261027 for ; Tue, 9 Nov 2021 08:52:33 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org B6C3261027 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmx.de Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=lists.denx.de Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 240848349B; Tue, 9 Nov 2021 09:52:32 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.b="U/DYIHqL"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id DD3E68368C; Tue, 9 Nov 2021 09:52:29 +0100 (CET) Received: from mout.gmx.net (mout.gmx.net [212.227.17.21]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id B7C8A8347E for ; Tue, 9 Nov 2021 09:52:26 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=xypron.glpk@gmx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1636447937; bh=GDv+UfbD+DASF0uLbm5/Tdrg9xTZVlU4e+1ivGyk0rs=; h=X-UI-Sender-Class:Date:Subject:To:Cc:References:From:In-Reply-To; b=U/DYIHqLnYi+qVV4q+OS78mRxnGqM5f8xoIxHSHsFKTLWQL2EsOTiuWVW8QumhVhc 6Gs0RF0e3dAYef4XEFqGYuKnHR2jg+EfNCCdiXqbeDqzfu5t8ZpjLrqbsF9MmrqLdi 5p5XZMJf/iaTfksNaRtwehhYXw/8h6bYM/wdoH3M= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from [192.168.123.55] ([88.152.144.157]) by mail.gmx.net (mrgmx104 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MCsQ4-1mt8Iz1Lqy-008tev; Tue, 09 Nov 2021 09:52:17 +0100 Message-ID: <992e5359-7901-faa4-8473-737c41915e8b@gmx.de> Date: Tue, 9 Nov 2021 09:52:11 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.2.1 Subject: Re: [PATCH v3 02/18] pxe: Move API comments to the header files Content-Language: en-US To: Simon Glass Cc: Patrice Chotard , Artem Lapkin , Tom Rini , Joe Hershberger , Peter Hoyes , U-Boot Mailing List References: <20211014184811.482560-1-sjg@chromium.org> <20211014184811.482560-3-sjg@chromium.org> From: Heinrich Schuchardt In-Reply-To: <20211014184811.482560-3-sjg@chromium.org> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: quoted-printable X-Provags-ID: V03:K1:Sbt2UbEJ8t4kPZJU5w2oRNNaJykTKywJbUdjFKqVnWfjbUGG4JA 2Wpaj1wpf7/zAtv380HIpIQJ7Ru2FeWWjufPkMBInpBjBw8pY9S3JGZdJkjykLLNg8I/VGC pYPLNOur5DJYFa/oRoSRkFwZgPTdS58eQczUrIHi7utNn/EA7jQayY+Jti0KVJjOwa/Xuwi 8+PbiANKz81ZEdSvekB4A== X-UI-Out-Filterresults: notjunk:1;V03:K0:h+uNosUVclY=:1x/QxnUY/uBingJ4YSLAmW Pq626EmQhcXnGZFET6A4y3GglqeYbGCfjwLadUFNqWbGS4LDPh246JamQRKFH6jECEdAJlI8X Hj9XNPFrmN7U0FjahRinusWmWEtiXygjKcC9NUQrw6X/bMtZ5ox/v+v5dmKXWKjtP3BK4Xr0L adSsq0cEX7kjqqmRgE9Z+Vt71Ldm5gpZfnPY/Qsl4/4kEXGXInns/efsT4trAZ4BltuBuEtzA voSyxwntdvbRALx9/0aDe2lx08+/QkZ5uaaT+GSCOtKNhKh15UTo4mM0Q1Q2mZZURuSJu5RlV Wx46xY5BnuDJvMzZDTqjetNRcETpNzhcuRGu+gcrpO6t357SGEkVQnnfW3A8HLh1kLXL8pduT MwIiO7eP+wC7fI6/kkgQMRkBmHn2RpuvKJzahTBaLTxj2dOuikmc/OWYaBjj+VfEqj/IldC5g nWDJSzBUvRjyRFmV+LAT2sNj5/pMWhj7itz+R1V7xFGJzrQuXn+hH89yJ3i7GWN1ksaORKuBp w8tBv4Df6LAyhsusUnDuqcvw3VtcQ61MTKRFwp8M4nZ/1Rh5MIG14WdBAM5skBZHoTwIO7I2P ATxPVp5Wg2nzCZaPo9x02lF7mxAO4WjTOSMZIl0toi8elqMswlcvkbOxFXGq4sWOHfeAbmbni +cM3FXFIwkyrRVMmRRgElk7f2Ub4/yka/krskEHGiTjxfhgBbs2CjN/kkifWWo2DzyDBLc6My ckA20zw1HkFNHjW9LoWWM97Qa23N+Bgm173w8x52UAM4rDK8cX8RSFv3BoFdBMU18RP1N0bMN V1McKbuKjkkCn0g3/Wng88246RSvWIdodVEWtXrP4EOQh62qozUJk7EvFHeSgUG14LAiFlk73 3LXPXTjgL+i7iGp+91zZLPLhvD/lqS4AL2bzKL7rEjhgbMP5d5blOgjZYlLmvc8TaIeYFgJtx Rr62HmSOd1tXif8P5YqQeODe7LgbCtVtxRtuJyYsWlU+Fxdw3o9mXsO6e7FbPP+E6NtBPq3ci n9rDM0qmriDwvfW8cDchZrIOI/OP7ohVikKQSx//Ue1sGH2m2Sn+cqKYwbRhGFYkcmTnqQG13 PN3VWSVbO3Yh4E= X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.2 at phobos.denx.de X-Virus-Status: Clean On 10/14/21 20:47, Simon Glass wrote: > Put the function comments in the header file so that the full API can we > examined in one place. In a follow up patch you could include the header file in the generated HTML documentation of doc/api/. Best regards Heinrich > > Expand the comments to cover parameters and return values. > > Signed-off-by: Simon Glass > ---