[gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed

[gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed

[Chris Mayo]

---
Please consider this clarification of optfeature.

Chris

 eclass/eutils.eclass | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/eclass/eutils.eclass b/eclass/eutils.eclass
index fe4339f6b89..f35fa5980d7 100644
--- a/eclass/eutils.eclass
+++ b/eclass/eutils.eclass
@@ -827,8 +827,8 @@ use_if_iuse() {
 # @FUNCTION: optfeature
 # @USAGE: <short description> <package atom to match> [other atoms]
 # @DESCRIPTION:
-# Print out a message suggesting an optional package (or packages) which
-# provide the described functionality
+# Print out a message suggesting an optional package (or packages)
+# not currently installed which provides the described functionality.
 #
 # The following snippet would suggest app-misc/foo for optional foo support,
 # app-misc/bar or app-misc/baz[bar] for optional bar support
-- 
2.13.5

Re: [gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed

[Michael Orlitzky]

On 09/03/2017 11:56 AM, Chris Mayo wrote:
>  #
>  # The following snippet would suggest app-misc/foo for optional foo support,
>  # app-misc/bar or app-misc/baz[bar] for optional bar support
> 

Would the @EXAMPLE tag[0] make sense here?


[0] https://devmanual.gentoo.org/eclass-writing/index.html

Re: [gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed

[Chris Mayo]

On 03/09/17 22:22, Michael Orlitzky wrote:
> On 09/03/2017 11:56 AM, Chris Mayo wrote:
>>  #
>>  # The following snippet would suggest app-misc/foo for optional foo support,
>>  # app-misc/bar or app-misc/baz[bar] for optional bar support
>>
> 
> Would the @EXAMPLE tag[0] make sense here?
> 
> 
> [0] https://devmanual.gentoo.org/eclass-writing/index.html
> 

I believe @EXAMPLE is only for the first documentation block introducing the eclass.

At least where it is used for functions the text doesn't show up in the man page.
e.g. prefix.eclass hprefixify() and prefixify_ro()

https://devmanual.gentoo.org/eclass-reference/prefix.eclass/index.html

https://gitweb.gentoo.org/repo/gentoo.git/tree/eclass/prefix.eclass?id=61b861acd7b49083dab687e133f30f3331cb7480

Re: [gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed

[Michael Orlitzky]

On 09/06/2017 02:39 PM, Chris Mayo wrote:
> 
> I believe @EXAMPLE is only for the first documentation block introducing the eclass.
> 
> At least where it is used for functions the text doesn't show up in the man page.
> e.g. prefix.eclass hprefixify() and prefixify_ro()
> 

Looks like you're right, sorry for the noise.

Re: [gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed

[Patrice Clement]

Hi Chris

Sunday 03 Sep 2017 16:56:08, Chris Mayo wrote :
> ---
> Please consider this clarification of optfeature.
> 
> Chris
> 
>  eclass/eutils.eclass | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/eclass/eutils.eclass b/eclass/eutils.eclass
> index fe4339f6b89..f35fa5980d7 100644
> --- a/eclass/eutils.eclass
> +++ b/eclass/eutils.eclass
> @@ -827,8 +827,8 @@ use_if_iuse() {
>  # @FUNCTION: optfeature
>  # @USAGE: <short description> <package atom to match> [other atoms]
>  # @DESCRIPTION:
> -# Print out a message suggesting an optional package (or packages) which
> -# provide the described functionality
> +# Print out a message suggesting an optional package (or packages)
> +# not currently installed which provides the described functionality.
>  #
>  # The following snippet would suggest app-misc/foo for optional foo support,
>  # app-misc/bar or app-misc/baz[bar] for optional bar support
> -- 
> 2.13.5
> 
> 

We (Michal Gorny and I) have reviewed your patch and merged it.

Thanks!

-- 
Patrice Clement
Gentoo Linux developer
http://www.gentoo.org