# Gentoo Archives: gentoo-pms

From: Christian Faulhammer Ciaran McCreesh gentoo-pms@l.g.o Re: [gentoo-pms] EAPI cheat sheet (for review) Sat, 04 Apr 2009 19:33:54 20090404213339.4d4e1ddb@terra.solaris Re: [gentoo-pms] EAPI cheat sheet (for review) by Ciaran McCreesh
Hi,

Ciaran McCreesh <ciaran.mccreesh@××××××××××.com>:

> On Sat, 4 Apr 2009 02:12:06 +0200
> Christian Faulhammer <fauli@g.o> wrote:
> >  I will test it on my tree...you will get newer patches next week
> > probably.
>
> Sounds good.

Patch attached.  This version only references the tables, which is
kind of useless, but is what I took from appendix E.  Changing the
labels as stated below will be the proper solution.
By the way I have a patch ready that factors out the preamble to a
pms.cls file, making the source easier to read.  It builds on top of my
cheat sheet patch, so not ready yet.

> So what I'd like to be able to do is have it say "see section
> [funcs.src_unpack.3]" rather than "see section 1.2.3.4", and then when
> we have a labelled section, lay it out something like:

What is possible is to reference the heading of the section and even
the name from \label.  Displaying the label names in the margin should
be feasible, too, as far as I remember.

> I realise this is somewhat getting away from your original patch. But
> I strongly suspect that the cheat sheet will be a lot more useful if
> it has references to exactly what the new src_unpack is, for when
> people need to look it up -- and it would help if people didn't have
> to print out a new cheatsheet to get valid section references every
> time we tweak the wording in such a way that the section numbers
> change...

Correct, but a task I can't handle in the near future, I can give some
advise though and someone labelling all appropriate paragraphs would do
the biggest part.  They should have a naming scheme like:
eapi4:<function>:<name> where function is something like
install|phase|etc.

V-Li

--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode

<URL:http://gentoo.faulhammer.org/>

### Attachments

File name MIME type
0001-Desk-reference-for-quick-look-up.patch text/x-patch
signature.asc application/pgp-signature

### Replies

Subject Author
Re: [gentoo-pms] EAPI cheat sheet (for review) Ciaran McCreesh <ciaran.mccreesh@××××××××××.com>