From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 042E51382C5 for ; Mon, 12 Apr 2021 10:30:27 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 50A14E0831; Mon, 12 Apr 2021 10:30:23 +0000 (UTC) Received: from smtp.gentoo.org (mail.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id CF908E0822 for ; Mon, 12 Apr 2021 10:30:22 +0000 (UTC) From: Ulrich Mueller To: Florian Schmaus Cc: gentoo-dev@lists.gentoo.org Subject: Re: [gentoo-dev] [PATCH 1/3] rebar.eclass: fix @RETURN argument In-Reply-To: <20210412082902.162091-1-flo@geekplace.eu> (Florian Schmaus's message of "Mon, 12 Apr 2021 10:29:00 +0200") References: <20210412082902.162091-1-flo@geekplace.eu> Date: Mon, 12 Apr 2021 12:30:12 +0200 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Archives-Salt: ae60d5bd-b7fd-4a9e-befa-fc4507b679ee X-Archives-Hash: 7add5a8752bd84fbf6333f40d9050976 --=-=-= Content-Type: text/plain >>>>> On Mon, 12 Apr 2021, Florian Schmaus wrote: > -# @RETURN: full path with EPREFIX to a Erlang package/project on success, > -# code 1 when dependency is not found and code 2 if multiple versions of > -# dependency are found. > +# @RETURN: full path with EPREFIX to Erlang package/project on success, code 1 when dependency is not found and code 2 if multiple versions of dependency are found. I think the cure is worse than the disease here. That @RETURN is supposed to be in one line means that it should be short (otherwise it would be read as a paragraph). Any lenghty description belongs in @DESCRIPTION instead. Also, the "full path" is the function's output, not its return value. So, suggestion: # @RETURN: 0 success, 1 dependency not found, 2 multiple versions found (and the rest can go into @DESCRIPTION). Ulrich --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQFDBAEBCAAtFiEEtDnZ1O9xIP68rzDbUYgzUIhBXi4FAmB0ITQPHHVsbUBnZW50 b28ub3JnAAoJEFGIM1CIQV4u09YIAMlNRp7mpyfbZGBgNZd1BMb0p028K441ZM+w fG5rRqoo23xKxKC92XMQcj4i/W67FE2sQ0UbN32TDUzzSJpejprne41v/B0kf7NC WW88sjpAa3Gnm1drCvI5uaIgPuyJYJqJ4Y3vPGXFkpoQ5zCnYCzC+cbnNq6ifSxL 7JuC3BDBjbj7Ca6w6U+uIR4KwHVpuQa+aOu4FUQXd44E0Ta1IES6j7QlLRFgSek0 ov3clYvNzW9lLPZJCC1BZzCmAIkkc+G6sxUmCdUGSkrpG6Nwi1uZjnl/l/NVg4EZ 6aXsavIz2LtpkBc9+VMRlQu0XDCooF3AHTQJWUSRl0kk6I/6K64= =2is1 -----END PGP SIGNATURE----- --=-=-=--