The variables like ESVN_WC_REVISION and ESVN_WC_URL are undocumented in the devmanual.
(In reply to comment #0) > The variables like ESVN_WC_REVISION and ESVN_WC_URL are undocumented in the > devmanual. > I can't find any mention of ESVN_WC_REVISION in the eclass, and ESVN_WC_URL isn't really documented. hattya, could you let us know if ESVN_WC_URL should be something set in an ebuild, and why one would set it? I can only find one ebuild in the tree that mentions that variable.
(In reply to comment #1) > I can't find any mention of ESVN_WC_REVISION in the eclass, and ESVN_WC_URL > isn't really documented. I take this back. I see where it is created, but still doesn't tell me how it is intended to be used.
(In reply to comment #1) > hattya, could you let us know if ESVN_WC_URL should be something set in an > ebuild, and why one would set it? I can only find one ebuild in the tree that > mentions that variable. Consider one (a developer, a tester or a bleeding edge maniac) having a problem with a development program emerged from SVN. How would one know what SVN revision of that package one is using and/or had installed? For example, using the following code in the ebuild would at least leave a trace in the log files: pkg_postinst() { einfo "Emerged Program from SVN (${ESVN_WC_URL}) revision ${ESVN_WC_REVISION}." } This might avoid some complications when developers ask one to state the SVN revision they were using when an issue occured.
The eclass has a man page now if you install eclass-manpages.
(In reply to comment #4) > The eclass has a man page now if you install eclass-manpages. Yes, however 1) eclass-manpages is blocked by portage-manpages (which should be a more complete set of man pages?) 2) eclass-manpages has a file collision: * app-admin/webapp-config-1.50.16-r1 * /usr/share/man/man5/webapp.eclass.5.bz2 I'd also recommend to explicitly write out the meanings of those variables on the subversion.eclass manpage for extra clarity. PS: Before you told me, I didn't even know these man pages existed. Using Google, I found no references to them in the online Gentoo Development docs. Nor did I find there any reference to the DevManual. So in case my Google'ing skills didn't fail me today and Google is inerrant, this might be something to think about.
(In reply to comment #5) > (In reply to comment #4) > > The eclass has a man page now if you install eclass-manpages. > > Yes, however > 1) eclass-manpages is blocked by portage-manpages (which should be a more > complete set of man pages?) portage-manpages is deprecated in favour of eclass-manpages. If it contains useful docs that eclass-manpages doesn't then that should be added to eclass-manpages at some point... > 2) eclass-manpages has a file collision: > * app-admin/webapp-config-1.50.16-r1 > * /usr/share/man/man5/webapp.eclass.5.bz2 File a separate bug for that please. > I'd also recommend to explicitly write out the meanings of those variables on > the subversion.eclass manpage for extra clarity. I don't follow. What's missing? > PS: Before you told me, I didn't even know these man pages existed. Using > Google, I found no references to them in the online Gentoo Development docs. > Nor did I find there any reference to the DevManual. So in case my Google'ing > skills didn't fail me today and Google is inerrant, this might be something > to think about. Sure. It's still a work in progess but it should become documented somewhere...
> > 2) eclass-manpages has a file collision: > > * app-admin/webapp-config-1.50.16-r1 > > * /usr/share/man/man5/webapp.eclass.5.bz2 > > File a separate bug for that please. Here you go: bug 213436 > > I'd also recommend to explicitly write out the meanings of those variables on > > the subversion.eclass manpage for extra clarity. > > I don't follow. What's missing? Sorry, forgot to say: I didn't have time to read through the whole manpage, but I specifically meant the ESVN_WC_* variables returned by the subversion_wc_info function. Well, ESVN_WC_URL and ESVN_WC_REVISION should be self-explanatory to everyone using version control, but ESVN_WC_UUID, ESVN_WC_ROOT and ESVN_WC_PATH for example might not.
This will be fixed as soon as we have the eclasses automatically generate into devmanual's markup, which is bug #202656
