Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 369383 - document DOCS in VARIABLES section of devmanual's eapi/index.html and portage's ebuild.5
Summary: document DOCS in VARIABLES section of devmanual's eapi/index.html and portage...
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-05-30 19:46 UTC by Alexandre Rostovtsev (RETIRED)
Modified: 2012-11-02 17:53 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
patch for devmanual's ebuild-writing/eapi/text.xml (0001-Properly-document-the-DOCS-variable-in-ebuild-writin.patch,1.05 KB, patch)
2011-05-30 19:48 UTC, Alexandre Rostovtsev (RETIRED)
Details | Diff
patch for portage-2.2.0_alpha37's man/ebuild.5 (portage-2.2.0_alpha37-document-DOCS.patch,744 bytes, patch)
2011-05-30 19:49 UTC, Alexandre Rostovtsev (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Alexandre Rostovtsev (RETIRED) gentoo-dev 2011-05-30 19:46:23 UTC
EAPI=4 introduced support for a default src_install that installs documentation files listed in the DOCS variable. Unfortunately, this variable is not documented anywhere other than the code listing of this default src_install function, and as a result, some people are unaware of its existence.

I think that DOCS should be documented in the appropriate VARIABLES section in the devmanual's EAPI page (http://devmanual.gentoo.org/ebuild-writing/eapi/index.html#variables) and portage's ebuild.5 man page.

Patches for devmanual and portage are attached.
Comment 1 Alexandre Rostovtsev (RETIRED) gentoo-dev 2011-05-30 19:48:31 UTC
Created attachment 275215 [details, diff]
patch for devmanual's ebuild-writing/eapi/text.xml
Comment 2 Alexandre Rostovtsev (RETIRED) gentoo-dev 2011-05-30 19:49:51 UTC
Created attachment 275217 [details, diff]
patch for portage-2.2.0_alpha37's man/ebuild.5
Comment 3 Zac Medico gentoo-dev 2011-05-30 22:29:03 UTC
(In reply to comment #2)
> Created attachment 275217 [details, diff]
> patch for portage-2.2.0_alpha37's man/ebuild.5

Thanks, this is in git:

http://git.overlays.gentoo.org/gitweb/?p=proj/portage.git;a=commit;h=e8cd26c8a67236742e4187fa4bccf4731876ed23
Comment 4 Markos Chandras (RETIRED) gentoo-dev 2012-11-02 17:53:39 UTC
Thanks. Patch applied