Re: [gentoo-doc] Link to docs in ebuilds

[Jose Luis Rivero (YosWinK)]

Arun Raghavan wrote:
> On 4/17/06, Jose Luis Rivero (YosWinK) <yoswink@g.o> wrote:
>
>>Shyam Mani wrote:
>>
>>>Arun Raghavan wrote:
>>>
>>>[snip]
>>>
>>>Yeah, Yoswink IIRC had a similar plan quite sometime back. Yoswink,
>>>would you please share the ideas/details? I'll try digging up IRC logs
>>>as well to see if I can come up with anything.
>>>
>>
>>( sorry about the delay, I was on holidays :D )
>>
>>Nah, the main idea was behind improving integration between docs and
>>ebuilds by replacing "einfo" doc related lines with an own "e-function"
>>for gdp info. Not sure if this could help in anyway but sure isn't the
>>solution.
>
>
> I like the mock-up -- it's what I meant. Basically, what I was saying
> is something like this: if the ebuild has a particular variable
> (RELATED_DOC, say) defined, the notification message like yours would
> be displayed. I tried to see if I could hack this up, but I couldn't
> figure out where I could plug it in. I think the change is rather
> trivial.
>

I wrote "edoc" function to be used inside ebuilds (same way as einfo, 
ewarn, ...) when I made the mock-up. If you want to use it, feel free to 
pick up the patch [1] and apply it to /sbin/functions.sh. I just rewrite 
the patch few moments ago and it hasn't been tested but shouldn't eat 
any of your files :)

The rest of your idea about "particular variable" need to hack emerge, 
which is something I really want to avoid.

Wkr,

------------------------------------------------
José Luis Rivero <yoswink @ gentoo .org>
Gentoo Doc / Gentoo Alpha

[1] http://dev.gentoo.org/~yoswink/tmp/edoc-funtions.sh.patch
-- 
gentoo-doc@g.o mailing list