* [gentoo-pms] EAPI cheat sheet (for review)
@ 2009-04-01 16:05 Christian Faulhammer
2009-04-03 22:20 ` Christian Faulhammer
2009-04-03 22:56 ` Ciaran McCreesh
0 siblings, 2 replies; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-01 16:05 UTC (permalink / raw
To: gentoo-pms
[-- Attachment #1.1: Type: text/plain, Size: 422 bytes --]
Hi,
attached are two patches that will a) add the cheat sheet to the PMS
repository b) integrate it into the PMS document.
b happens by merging the two PDFs together
This is not yet intended for inclusion but a request for review from
your side.
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-Desk-reference-for-quick-look-up.patch --]
[-- Type: text/x-patch, Size: 5900 bytes --]
From e5ae6d1e3b229305e2d7b12eabff5277d58a2a97 Mon Sep 17 00:00:00 2001
From: Christian Faulhammer <fauli@gentoo.org>
Date: Tue, 31 Mar 2009 17:04:07 +0200
Subject: [PATCH] Desk reference for quick look-up
This contains a short summary of all EAPI features so far, similar to
appendix E of PMS, but with more information.
---
cheatsheet/eapi_cheatsheet.tex | 125 ++++++++++++++++++++++++++++++++++++++++
1 files changed, 125 insertions(+), 0 deletions(-)
create mode 100644 cheatsheet/eapi_cheatsheet.tex
diff --git a/cheatsheet/eapi_cheatsheet.tex b/cheatsheet/eapi_cheatsheet.tex
new file mode 100644
index 0000000..370edbf
--- /dev/null
+++ b/cheatsheet/eapi_cheatsheet.tex
@@ -0,0 +1,125 @@
+\documentclass[a4paper,notumble]{leaflet}
+\input{vc}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage{
+ url,
+ listings,
+ ifthen
+}
+\usepackage[orig,english]{isodate}
+\newcommand{\code}[1]{\texttt{#1}}
+\newcommand{\version}{0.2}
+\renewcommand{\familydefault}{\sfdefault}
+\urlstyle{sf}
+
+\title{EAPI Cheat Sheet}
+\author{Christian Faulhammer\thanks{fauli@gentoo.org}}
+\ifthenelse{\equal{\VCDateISO}{}}
+{
+ \date{Version \version{}, generated on: \\\today}
+}{
+ \date{Version \version\\\printdate{\VCDateISO}}
+}
+\CutLine*{1}
+\CutLine*{3}
+\CutLine*{4}
+\CutLine*{6}
+\begin{document}
+\maketitle
+\thispagestyle{empty}
+\begin{abstract}
+ This overview is meant for quick reference of the main EAPI features
+ found in Gentoo. It is intended for everyone having to write
+ ebuilds regularly, it is neither a full ebuild reference nor
+ complete regarding EAPI changes. For the latter, refer to the
+ official Package Manager
+ specification\footnote{\url{http://www.gentoo.org/proj/en/qa/pms/}}.
+
+ Official EAPIs are consecutively numbered (other characters are
+ allowed though) and do usually stack, meaning that an EAPI contains
+ all features found in the previous one. This is no requirement as
+ two EAPIs can in theory be totally different from one another, but
+ for ease of use this is not wanted for the official EAPIs.
+ Situations where this is not the case will be noted in the
+ appropriate sections.
+
+ Please report mistakes or enhancements to this document via the
+ Gentoo bug tracking system\footnote{\url{http://bugs.gentoo.org/}}
+ to the original author or the PMS team.
+
+ This document is released under the Creative Commons
+ Attribution-Share Alike 3.0
+ Licence\footnote{\url{http://creativecommons.org/licenses/by-sa/3.0/}}.
+\end{abstract}
+\section{EAPI 0}
+\label{sec:eapi0}
+If there is no EAPI explicitely specified, EAPI 0 is taken.
+
+Currently there is no full specification what EAPI 0 includes.
+Portage, official ebuild documentation and existing ebuilds set the
+standard here, although obvious errors are still errors.
+\newpage
+\section{EAPI 1}
+\label{sec:eapi1}
+\subsection{Additions/Changes}
+\label{sec:eapi1-additions}
+\begin{description}
+\item[IUSE defaults] An USE flag can be marked as mandatory (if not
+ disabled explicitely by user configuration) with a "+" sign in
+ front.
+\item[Named SLOT dependencies] Dependencies can explicitely request a
+ specific slot by using the \code{dev-libs/foo:SLOT} syntax.
+\end{description}
+\section{EAPI 2 (2008-09-25)}
+\label{sec:eapi2}
+\subsection{Additions/Changes}
+\label{sec:eapi2-additions}
+\begin{description}
+\item[\code{SRC\_URI} arrows] Allows redirection of upstream file
+ naming scheme by using an "arrow" (\code{->}) to a new file name in
+ DISTDIR.
+\item[USE dependencies] Dependencies can be specified to be built with
+ or without a specific USE flag, thus getting rid of countless
+ \code{built\_with\_use} checks. A more sophisticated syntax is to
+ be found in EAPI 3.
+ \begin{description}
+ \item{[opt]} The flag must be enabled.
+ \item{[opt=]} The flag must be enabled if the flag is enabled for the
+ package with the dependency, or disabled otherwise.
+ \item{[!opt=]} The flag must be disabled if the flag is enabled for
+ the package with the dependency, or enabled otherwise.
+ \item{[opt?]} The flag must be enabled if the flag is enabled for the
+ package with the dependency.
+ \item{[!opt?]} The flag must be disabled if the use flag is disabled
+ for the package with the dependency.
+ \item{[-opt]} The flag must be disabled.
+ \end{description}
+\item[Blocker syntax] A single exclamation mark as a blocker may be
+ ignored by the package manager as long as the stated package is
+ uninstalled later on. Two exclamation marks are a strong blocker
+ and will always be respected.
+\item[\code{src\_configure, src\_prepare}] Both new functions provide
+ finer granularity in the ebuild's structure. Configure calls should
+ be moved from \code{src\_compile} to \code{src\_configure}.
+ Patching and other preparing tasks must no longer take place in
+ \code{src\_unpack} but in \code{src\_prepare}.
+\item[Default functions] The default functions for
+ \code{pkg\_nofetch}, \code{src\_unpack}, \code{src\_prepare},
+ \code{src\_configure}, \code{src\_compile} and \code{src\_test} can
+ be called via \code{default\_\emph{phasename}}, so small additions
+ you need won't be accompanied by a complete reimplementation of the phase.
+ Additionally as a shorthand for the current phase's default
+ definition \code{default} can be invoked.
+\item[\code{doman} language support] The \code{doman} installation
+ function recognizes lanugage specific man page extensions and
+ behaves accordingly.
+\end{description}
+\newpage
+\section{EAPI 3}
+\label{sec:eapi3}
+\subsection{Additions/Changes}
+\label{sec:eapi3-additions}
+\subsection{Removals/Bans}
+\label{sec:eapi3-removalsbans}
+\end{document}
--
1.6.0.6
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.3: 0002-Integrate-cheat-sheet-into-PMS-document.patch --]
[-- Type: text/x-patch, Size: 2480 bytes --]
From 0d6f6fba72da517dcc26f9c7394f841597f021d5 Mon Sep 17 00:00:00 2001
From: Christian Faulhammer <fauli@gentoo.org>
Date: Tue, 31 Mar 2009 17:05:24 +0200
Subject: [PATCH] Integrate cheat sheet into PMS document
---
Makefile | 8 ++++++--
credits.tex | 3 ++-
pms.tex | 4 +++-
3 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/Makefile b/Makefile
index 8b49437..3185024 100644
--- a/Makefile
+++ b/Makefile
@@ -5,11 +5,11 @@ clean :
rm -f *~ *.pdf *.dvi *.log *.aux *.bbl *.blg *.toc *.lol *.loa *.lox \
*.lot *.out *.html *.css *.png *.4ct *.4tc *.idv *.lg *.tmp *.xref vc.tex || true
-LATEXFILES = $(shell ls *.tex)
+LATEXFILES = $(shell find -name '*.tex')
LISTINGFILES = $(shell ls *.listing)
SOURCEFILES = $(LATEXFILES) $(LISTINGFILES)
-pms.pdf: $(SOURCEFILES) pms.bbl vc.tex
+pms.pdf: $(SOURCEFILES) pms.bbl vc.tex eapi_cheatsheet.pdf
pdflatex pms
pdflatex pms
pdflatex pms
@@ -31,6 +31,10 @@ pms.bbl: pms.bib pms.tex vc.tex
latex pms
bibtex pms
+eapi_cheatsheet.pdf: vc.tex
+ pdflatex cheatsheet/eapi_cheatsheet
+ pdflatex cheatsheet/eapi_cheatsheet
+
vc.tex: pms.tex
/bin/sh ./vc
diff --git a/credits.tex b/credits.tex
index 8494516..77d40bd 100644
--- a/credits.tex
+++ b/credits.tex
@@ -3,7 +3,8 @@
Thanks to Mike Kelly (package manager provided utilities, section~\ref{sec:pkg-mgr-commands}), Danny van
Dyk (ebuild functions, section~\ref{sec:ebuild-functions}), David Leverton (various sections) and
Petteri Räty (environment state, section~\ref{sec:ebuild-env-state}) for contributions. Thanks to
-Christian Faulhammer for fixing some of the more horrible formatting screwups. Thanks also to Mike
+Christian Faulhammer for fixing some of the more horrible formatting
+screwups and providing the EAPI cheat sheet. Thanks also to Mike
Frysinger and Brian Harring for proof-reading and suggestions for fixes and/or clarification.
\section*{Copyright and Licence}
diff --git a/pms.tex b/pms.tex
index 8a14f30..fb7bc7e 100644
--- a/pms.tex
+++ b/pms.tex
@@ -18,7 +18,8 @@
parskip,
verbatim,
algorithm,
- algorithmic
+ algorithmic,
+ pdfpages
}
\usepackage[orig,english]{isodate}
\usepackage[DIV13]{typearea}
@@ -162,6 +163,7 @@
\bibliography{pms}
+\includepdf[pages=-,landscape]{eapi_cheatsheet}
\end{document}
% vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :
--
1.6.0.6
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply related [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-01 16:05 [gentoo-pms] EAPI cheat sheet (for review) Christian Faulhammer
@ 2009-04-03 22:20 ` Christian Faulhammer
2009-04-03 22:56 ` Ciaran McCreesh
1 sibling, 0 replies; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-03 22:20 UTC (permalink / raw
To: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 410 bytes --]
Hi,
Christian Faulhammer <fauli@gentoo.org>:
> This is not yet intended for inclusion but a request for review from
> your side.
As there were no "bugs" reported neither from -dev nor from here, I
hereby request inclusion into PMS.
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-01 16:05 [gentoo-pms] EAPI cheat sheet (for review) Christian Faulhammer
2009-04-03 22:20 ` Christian Faulhammer
@ 2009-04-03 22:56 ` Ciaran McCreesh
2009-04-04 0:12 ` Christian Faulhammer
1 sibling, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-03 22:56 UTC (permalink / raw
To: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 799 bytes --]
On Wed, 1 Apr 2009 18:05:08 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> attached are two patches that will a) add the cheat sheet to the PMS
> repository b) integrate it into the PMS document.
> b happens by merging the two PDFs together
> This is not yet intended for inclusion but a request for review from
> your side.
Hrm, something I've been wondering here... Is there a way to do it as
two separate PDFs, but have \refs work? So you'd be able to \ref the
relevant parts of PMS from the cheatsheet...
And if there is, it's probably best if we stop reffing PMS features by
table and introduce a whole load of labels for the most appropriate
paragraph instead. And if we do that, can we do fancy named paragraphs
like the C++ standard does?
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-03 22:56 ` Ciaran McCreesh
@ 2009-04-04 0:12 ` Christian Faulhammer
2009-04-04 15:48 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-04 0:12 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1317 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Wed, 1 Apr 2009 18:05:08 +0200
> Christian Faulhammer <fauli@gentoo.org> wrote:
> > attached are two patches that will a) add the cheat sheet to the PMS
> > repository b) integrate it into the PMS document.
> > b happens by merging the two PDFs together
> > This is not yet intended for inclusion but a request for review
> > from your side.
>
> Hrm, something I've been wondering here... Is there a way to do it as
> two separate PDFs, but have \refs work? So you'd be able to \ref the
> relevant parts of PMS from the cheatsheet...
Established: http://www.ctan.org/get/macros/latex/required/tools/xr.pdf
Experimental but maybe more sophisticated:
http://www.ctan.org/get/macros/latex/contrib/oberdiek/zref.pdf
I will test it on my tree...you will get newer patches next week
probably.
> And if there is, it's probably best if we stop reffing PMS features by
> table and introduce a whole load of labels for the most appropriate
> paragraph instead. And if we do that, can we do fancy named paragraphs
> like the C++ standard does?
Please elaborate.
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-04 0:12 ` Christian Faulhammer
@ 2009-04-04 15:48 ` Ciaran McCreesh
2009-04-04 19:33 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-04 15:48 UTC (permalink / raw
To: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1368 bytes --]
On Sat, 4 Apr 2009 02:12:06 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> I will test it on my tree...you will get newer patches next week
> probably.
Sounds good.
> > And if there is, it's probably best if we stop reffing PMS features
> > by table and introduce a whole load of labels for the most
> > appropriate paragraph instead. And if we do that, can we do fancy
> > named paragraphs like the C++ standard does?
>
> Please elaborate.
In the C++ standard, sections and paragraphs are named, not numbered.
It's probably easiest to look at a PDF:
http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2009/n2857.pdf
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:
src_unpack, type 3 [funcs.src_unpack.3]
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...
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-04 15:48 ` Ciaran McCreesh
@ 2009-04-04 19:33 ` Christian Faulhammer
2009-04-04 19:52 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-04 19:33 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1.1: Type: text/plain, Size: 1902 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Sat, 4 Apr 2009 02:12:06 +0200
> Christian Faulhammer <fauli@gentoo.org> 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/>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-Desk-reference-for-quick-look-up.patch --]
[-- Type: text/x-patch, Size: 8600 bytes --]
From a84362bc332dd3c782ac646f6c804ee38da25402 Mon Sep 17 00:00:00 2001
From: Christian Faulhammer <fauli@gentoo.org>
Date: Sat, 4 Apr 2009 18:17:08 +0200
Subject: [PATCH] Desk reference for quick look-up
This contains a short summary of all EAPI features so far, similar to
appendix E of PMS, but with more information.
---
Makefile | 8 ++-
cheatsheet/eapi_cheatsheet.tex | 133 ++++++++++++++++++++++++++++++++++++++++
credits.tex | 3 +-
pms.tex | 4 +-
4 files changed, 144 insertions(+), 4 deletions(-)
create mode 100644 cheatsheet/eapi_cheatsheet.tex
diff --git a/Makefile b/Makefile
index 8b49437..351a4c6 100644
--- a/Makefile
+++ b/Makefile
@@ -5,13 +5,14 @@ clean :
rm -f *~ *.pdf *.dvi *.log *.aux *.bbl *.blg *.toc *.lol *.loa *.lox \
*.lot *.out *.html *.css *.png *.4ct *.4tc *.idv *.lg *.tmp *.xref vc.tex || true
-LATEXFILES = $(shell ls *.tex)
+LATEXFILES = $(shell find -name '*.tex')
LISTINGFILES = $(shell ls *.listing)
SOURCEFILES = $(LATEXFILES) $(LISTINGFILES)
-pms.pdf: $(SOURCEFILES) pms.bbl vc.tex
+pms.pdf: $(SOURCEFILES) pms.bbl vc.tex eapi_cheatsheet.pdf
pdflatex pms
pdflatex pms
+ pdflatex cheatsheet/eapi_cheatsheet
pdflatex pms
pms.html: $(SOURCEFILES) pms.bbl
@@ -31,6 +32,9 @@ pms.bbl: pms.bib pms.tex vc.tex
latex pms
bibtex pms
+eapi_cheatsheet.pdf: vc.tex
+ pdflatex cheatsheet/eapi_cheatsheet
+
vc.tex: pms.tex
/bin/sh ./vc
diff --git a/cheatsheet/eapi_cheatsheet.tex b/cheatsheet/eapi_cheatsheet.tex
new file mode 100644
index 0000000..619d5a1
--- /dev/null
+++ b/cheatsheet/eapi_cheatsheet.tex
@@ -0,0 +1,133 @@
+\documentclass[a4paper,notumble]{leaflet}
+\input{vc}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage{
+ url,
+ hyperref,
+ listings,
+ ifthen,
+ fancyref,
+ xr-hyper
+}
+\usepackage[orig,english]{isodate}
+\newcommand{\code}[1]{\texttt{#1}}
+\newcommand{\version}{0.2}
+\renewcommand{\familydefault}{\sfdefault}
+\urlstyle{sf}
+\externaldocument{pms}
+
+\title{EAPI Cheat Sheet}
+\author{Christian Faulhammer\thanks{fauli@gentoo.org}}
+\ifthenelse{\equal{\VCDateISO}{}}
+{
+ \date{Version \version{}, generated on: \\\today}
+}{
+ \date{Version \version\\\printdate{\VCDateISO}}
+}
+\CutLine*{1}
+\CutLine*{3}
+\CutLine*{4}
+\CutLine*{6}
+\begin{document}
+\maketitle
+\thispagestyle{empty}
+\begin{abstract}
+ This overview is meant for quick reference of the main EAPI features
+ found in Gentoo. It is intended for everyone having to write
+ ebuilds regularly, it is neither a full ebuild reference nor
+ complete regarding EAPI changes. For the latter, refer to the
+ official Package Manager
+ specification\footnote{\url{http://www.gentoo.org/proj/en/qa/pms/}}.
+
+ Official EAPIs are consecutively numbered (other characters are
+ allowed though) and do usually stack, meaning that an EAPI contains
+ all features found in the previous one. This is no requirement as
+ two EAPIs can in theory be totally different from one another, but
+ for ease of use this is not wanted for the official EAPIs.
+ Situations where this is not the case will be noted in the
+ appropriate sections.
+
+ Please report mistakes or enhancements to this document via the
+ Gentoo bug tracking system\footnote{\url{http://bugs.gentoo.org/}}
+ to the original author or the PMS team.
+
+ This document is released under the Creative Commons
+ Attribution-Share Alike 3.0
+ Licence\footnote{\url{http://creativecommons.org/licenses/by-sa/3.0/}}.
+\end{abstract}
+\section{EAPI 0}
+\label{sec:cs:eapi0}
+If there is no EAPI explicitely specified, EAPI 0 is taken.
+
+Currently there is no full specification what EAPI 0 includes.
+Portage, official ebuild documentation and existing ebuilds set the
+standard here, although obvious errors are still errors.
+\newpage
+\section{EAPI 1}
+\label{sec:cs:eapi1}
+\subsection{Additions/Changes}
+\label{sec:cs:eapi1-additions}
+\begin{description}
+\item[IUSE defaults] An USE flag can be marked as mandatory (if not
+ disabled explicitely by user configuration) with a "+" sign in
+ front. \Fref{tab:iuse-defaults-table}.
+\item[Named SLOT dependencies] Dependencies can explicitely request a
+ specific slot by using the \code{dev-libs/foo:SLOT} syntax.
+ \Fref{tab:slot-deps-table}.
+\end{description}
+\section{EAPI 2 (2008-09-25)}
+\label{sec:cs:eapi2}
+\subsection{Additions/Changes}
+\label{sec:cs:eapi2-additions}
+\begin{description}
+\item[\code{SRC\_URI} arrows] Allows redirection of upstream file
+ naming scheme by using an "arrow" (\code{->}) to a new file name in
+ DISTDIR. \Fref{tab:uri-arrows-table}.
+\item[USE dependencies] Dependencies can be specified to be built with
+ or without a specific USE flag, thus getting rid of countless
+ \code{built\_with\_use} checks. A more sophisticated syntax is to
+ be found in EAPI 3. \Fref{tab:use-deps-table}.
+ \begin{description}
+ \item{[opt]} The flag must be enabled.
+ \item{[opt=]} The flag must be enabled if the flag is enabled for the
+ package with the dependency, or disabled otherwise.
+ \item{[!opt=]} The flag must be disabled if the flag is enabled for
+ the package with the dependency, or enabled otherwise.
+ \item{[opt?]} The flag must be enabled if the flag is enabled for the
+ package with the dependency.
+ \item{[!opt?]} The flag must be disabled if the use flag is disabled
+ for the package with the dependency.
+ \item{[-opt]} The flag must be disabled.
+ \end{description}
+\item[Blocker syntax] A single exclamation mark as a blocker may be
+ ignored by the package manager as long as the stated package is
+ uninstalled later on. Two exclamation marks are a strong blocker
+ and will always be respected. \Fref{tab:bang-strength-table}
+\item[\code{src\_configure, src\_prepare}] Both new functions provide
+ finer granularity in the ebuild's structure. Configure calls should
+ be moved from \code{src\_compile} to \code{src\_configure}.
+ Patching and other preparing tasks must no longer take place in
+ \code{src\_unpack} but in \code{src\_prepare}.
+ \Fref{tab:src-prepare-table} and \fref{tab:src-configure-table}.
+\item[Default functions] The default functions for
+ \code{pkg\_nofetch}, \code{src\_unpack}, \code{src\_prepare},
+ \code{src\_configure}, \code{src\_compile} and \code{src\_test} can
+ be called via \code{default\_\emph{phasename}}, so small additions
+ you need won't be accompanied by a complete reimplementation of the
+ phase. Additionally as a shorthand for the current phase's default
+ definition \code{default} can be invoked.
+ \Fref{tab:default-phase-function-table} and
+ \fref{tab:default-function-table}.
+\item[\code{doman} language support] The \code{doman} installation
+ function recognizes lanugage specific man page extensions and
+ behaves accordingly. \Fref{tab:doman-table}.
+\end{description}
+\newpage
+\section{EAPI 3}
+\label{sec:cs:eapi3}
+\subsection{Additions/Changes}
+\label{sec:cs:eapi3-additions}
+\subsection{Removals/Bans}
+\label{sec:cs:eapi3-removalsbans}
+\end{document}
diff --git a/credits.tex b/credits.tex
index 8494516..77d40bd 100644
--- a/credits.tex
+++ b/credits.tex
@@ -3,7 +3,8 @@
Thanks to Mike Kelly (package manager provided utilities, section~\ref{sec:pkg-mgr-commands}), Danny van
Dyk (ebuild functions, section~\ref{sec:ebuild-functions}), David Leverton (various sections) and
Petteri Räty (environment state, section~\ref{sec:ebuild-env-state}) for contributions. Thanks to
-Christian Faulhammer for fixing some of the more horrible formatting screwups. Thanks also to Mike
+Christian Faulhammer for fixing some of the more horrible formatting
+screwups and providing the EAPI cheat sheet. Thanks also to Mike
Frysinger and Brian Harring for proof-reading and suggestions for fixes and/or clarification.
\section*{Copyright and Licence}
diff --git a/pms.tex b/pms.tex
index 8a14f30..fb7bc7e 100644
--- a/pms.tex
+++ b/pms.tex
@@ -18,7 +18,8 @@
parskip,
verbatim,
algorithm,
- algorithmic
+ algorithmic,
+ pdfpages
}
\usepackage[orig,english]{isodate}
\usepackage[DIV13]{typearea}
@@ -162,6 +163,7 @@
\bibliography{pms}
+\includepdf[pages=-,landscape]{eapi_cheatsheet}
\end{document}
% vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :
--
1.6.0.6
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply related [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-04 19:33 ` Christian Faulhammer
@ 2009-04-04 19:52 ` Ciaran McCreesh
2009-04-04 20:14 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-04 19:52 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1810 bytes --]
On Sat, 4 Apr 2009 21:33:39 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> > 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.
That would be helpful.
> > 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.
Yeah, that'd work.
I'm wondering what our best merge strategy is here. I'm inclined to
think we're best off fixing all the labels on the eapi-3 branch (even
if we can't get them displayed or used for named references just yet),
rebasing that onto master (not much has diverged) once we have the
go-ahead from the Council either next meeting or the one after
(probably...) and then doing the cheat-sheet with EAPI 3 included on top
of that.
Or were you particularly desperate to get the cheat-sheet in for EAPI 2?
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-04 19:52 ` Ciaran McCreesh
@ 2009-04-04 20:14 ` Christian Faulhammer
2009-04-04 20:23 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-04 20:14 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 2494 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Sat, 4 Apr 2009 21:33:39 +0200
> Christian Faulhammer <fauli@gentoo.org> wrote:
> > > 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.
>
> That would be helpful.
Ok, I will investigate and present some working code snippets so
everyone knows how to handle that.
> > > 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.
>
> Yeah, that'd work.
>
> I'm wondering what our best merge strategy is here. I'm inclined to
> think we're best off fixing all the labels on the eapi-3 branch (even
> if we can't get them displayed or used for named references just yet),
> rebasing that onto master (not much has diverged) once we have the
> go-ahead from the Council either next meeting or the one after
> (probably...) and then doing the cheat-sheet with EAPI 3 included on
> top of that.
That sounds ok to me. Getting those labels in is the most important
part...so that should be feature wise for every feature listed in
appendix E. Volunteers?
> Or were you particularly desperate to get the cheat-sheet in for EAPI
> 2?
No, a version has been announced and is available for download. So no
haste here. What time frame do you expect to approve EAPI 3?
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-04 20:14 ` Christian Faulhammer
@ 2009-04-04 20:23 ` Ciaran McCreesh
2009-04-05 19:21 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-04 20:23 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1461 bytes --]
On Sat, 4 Apr 2009 22:14:11 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> > I'm wondering what our best merge strategy is here. I'm inclined to
> > think we're best off fixing all the labels on the eapi-3 branch
> > (even if we can't get them displayed or used for named references
> > just yet), rebasing that onto master (not much has diverged) once
> > we have the go-ahead from the Council either next meeting or the
> > one after (probably...) and then doing the cheat-sheet with EAPI 3
> > included on top of that.
>
> That sounds ok to me. Getting those labels in is the most important
> part...so that should be feature wise for every feature listed in
> appendix E. Volunteers?
I'm going to be with laptop stuck in the middle of wet, miserable, rainy
nowhere and relying upon a very slow and dodgy mobile internet
connection over Easter weekend, so that'll give me something to do.
> > Or were you particularly desperate to get the cheat-sheet in for
> > EAPI 2?
>
> No, a version has been announced and is available for download. So
> no haste here. What time frame do you expect to approve EAPI 3?
We were sort of hoping either next Council meeting or the one after,
assuming Portage support is far enough along that we can say for sure
which features are going to be in. So that's either a week off or three
weeks off, although obviously these things rarely work as planned...
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-04 20:23 ` Ciaran McCreesh
@ 2009-04-05 19:21 ` Christian Faulhammer
2009-04-07 17:39 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-05 19:21 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1915 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> I'm going to be with laptop stuck in the middle of wet, miserable,
> rainy nowhere
That sounds like Scotland.
> and relying upon a very slow and dodgy mobile internet
> connection over Easter weekend, so that'll give me something to do.
Great.
Anyway, the implementation of that label thing is really easy and
straightforward. But there are still two options:
a) redefine \label, so it always displays its parameter in the margin.
b) use a new \pmslabel and \pmsref command which will set a label and
display it in the margin without touching the original \label command.
\pmsref would then display something like "eapi2:phase:src_install on
page 5". So using \ref will still return the section.
Implementation differs only in detail, a) allows using the standard
commands, b) needs the writer to think about what he does. I vote for
b) as a) may break in funny environments as floats and friends (table,
figure, minipage etc.).
We can talk about the look of the reference and margin label later,
but I propose a normal text for the reference and a framed box for the
margin label.
Next thing. Putting those labels in the margin of the page makes it
quite crowded. From a typographical point of view your page layout is
just horrible. So I propose a redesign of the text and white space
proportions, which will lead to larger margins all around (and pushing
the PMS beyond 100 pages, according to my first test runs)
Timeframe? You want EAPI 3 to go in before I do my stuff here:
i) factor out pms.cls and comment the preamble a bit
ii) cheat sheet with EAPI 3
iii) provide named \label and \ref commands
iv) redesing page layout
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-05 19:21 ` Christian Faulhammer
@ 2009-04-07 17:39 ` Ciaran McCreesh
2009-04-08 23:05 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-07 17:39 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1982 bytes --]
On Sun, 5 Apr 2009 21:21:16 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> > I'm going to be with laptop stuck in the middle of wet, miserable,
> > rainy nowhere
>
> That sounds like Scotland.
Scotland has working interwebnets! I'm going to be in The North, which
is far worse.
> a) redefine \label, so it always displays its parameter in the margin.
> b) use a new \pmslabel and \pmsref command which will set a label and
> display it in the margin without touching the original \label command.
> \pmsref would then display something like "eapi2:phase:src_install on
> page 5". So using \ref will still return the section.
>
> Implementation differs only in detail, a) allows using the standard
> commands, b) needs the writer to think about what he does. I vote for
> b) as a) may break in funny environments as floats and friends (table,
> figure, minipage etc.).
b) is fine. If there's any chance a) will cause weird breakages, we
should probably avoid it for sanity's sake.
> Next thing. Putting those labels in the margin of the page makes it
> quite crowded. From a typographical point of view your page layout is
> just horrible. So I propose a redesign of the text and white space
> proportions, which will lead to larger margins all around (and pushing
> the PMS beyond 100 pages, according to my first test runs)
Mmm. The problem with pushing that too far is that you end up with two
paragraphs on a page... I'm already printing 2-up for when I want to
read PMS properly. Don't make me have to buy an ebook reader!
> Timeframe? You want EAPI 3 to go in before I do my stuff here:
>
> i) factor out pms.cls and comment the preamble a bit
> ii) cheat sheet with EAPI 3
> iii) provide named \label and \ref commands
> iv) redesing page layout
Are you comfortable working off my eapi-3 branch that I rebase every
now and again?
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-07 17:39 ` Ciaran McCreesh
@ 2009-04-08 23:05 ` Christian Faulhammer
2009-04-08 23:09 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-08 23:05 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1822 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Sun, 5 Apr 2009 21:21:16 +0200
> Christian Faulhammer <fauli@gentoo.org> wrote:
> > Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> > > I'm going to be with laptop stuck in the middle of wet, miserable,
> > > rainy nowhere
> >
> > That sounds like Scotland.
>
> Scotland has working interwebnets! I'm going to be in The North, which
> is far worse.
What the hell is north of Scotland in the UK? Don't tell me you are
going abroad.
> > Next thing. Putting those labels in the margin of the page makes
> > it quite crowded. From a typographical point of view your page
> > layout is just horrible. So I propose a redesign of the text and
> > white space proportions, which will lead to larger margins all
> > around (and pushing the PMS beyond 100 pages, according to my first
> > test runs)
>
> Mmm. The problem with pushing that too far is that you end up with two
> paragraphs on a page... I'm already printing 2-up for when I want to
> read PMS properly. Don't make me have to buy an ebook reader!
I will run some tests what looks best, and will present sample pages
here...
> > Timeframe? You want EAPI 3 to go in before I do my stuff here:
> >
> > i) factor out pms.cls and comment the preamble a bit
> > ii) cheat sheet with EAPI 3
> > iii) provide named \label and \ref commands
> > iv) redesing page layout
>
> Are you comfortable working off my eapi-3 branch that I rebase every
> now and again?
Not really, as I have some more pressing tasks on my agenda I am fine
with postponing above tasks after the EAPI 3 merge.
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-08 23:05 ` Christian Faulhammer
@ 2009-04-08 23:09 ` Ciaran McCreesh
2009-04-09 17:16 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-08 23:09 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 957 bytes --]
On Thu, 9 Apr 2009 01:05:10 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> > Scotland has working interwebnets! I'm going to be in The North,
> > which is far worse.
>
> What the hell is north of Scotland in the UK? Don't tell me you are
> going abroad.
No, Scotland's north of The North. I'll be going south to The North.
Check a road sign.
> > Mmm. The problem with pushing that too far is that you end up with
> > two paragraphs on a page... I'm already printing 2-up for when I
> > want to read PMS properly. Don't make me have to buy an ebook
> > reader!
>
> I will run some tests what looks best, and will present sample pages
> here...
Sounds good.
> > Are you comfortable working off my eapi-3 branch that I rebase every
> > now and again?
>
> Not really, as I have some more pressing tasks on my agenda I am fine
> with postponing above tasks after the EAPI 3 merge.
Alright.
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-08 23:09 ` Ciaran McCreesh
@ 2009-04-09 17:16 ` Christian Faulhammer
2009-04-09 18:15 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-09 17:16 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1.1: Type: text/plain, Size: 707 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
[margin size]
> > I will run some tests what looks best, and will present sample
> > pages here...
>
> Sounds good.
Attached is a PDF file with always two pages of one layout type. A
margin note label is found in every example. Number of pages for the
whole PMS in the following order:
113 (best from a typographical point of view, although not suited for
technical texts in my opinion)
80 (better and enough room for the margin note)
75
72
70 (current layout)
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #1.2: PMS-sample-pages.pdf --]
[-- Type: application/pdf, Size: 133571 bytes --]
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-09 17:16 ` Christian Faulhammer
@ 2009-04-09 18:15 ` Ciaran McCreesh
2009-04-10 10:21 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-09 18:15 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 617 bytes --]
On Thu, 9 Apr 2009 19:16:34 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> Attached is a PDF file with always two pages of one layout type. A
> margin note label is found in every example. Number of pages for the
> whole PMS in the following order:
Mmm. Is part of the problem that we're not using a book style layout?
How does it look if we go for even-odd pages, with narrow outside
margins but larger inner margins, with labels always shown on the inner
margins?
I realise I'm only being picky about this because I'm not the one
who has to work out how to do it :P
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-09 18:15 ` Ciaran McCreesh
@ 2009-04-10 10:21 ` Christian Faulhammer
2009-04-10 11:16 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-10 10:21 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1190 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Thu, 9 Apr 2009 19:16:34 +0200
> Christian Faulhammer <fauli@gentoo.org> wrote:
> > Attached is a PDF file with always two pages of one layout type. A
> > margin note label is found in every example. Number of pages for the
> > whole PMS in the following order:
>
> Mmm. Is part of the problem that we're not using a book style layout?
> How does it look if we go for even-odd pages, with narrow outside
> margins but larger inner margins, with labels always shown on the
> inner margins?
You confuse outside and inside here. Both inner margins are as wide
as one outer margin. For the PMS one-sided is perfect as people will
print it out one-sided, so the unequal margins would just look odd.
Layout 2 and 3 are the ones I favour, but I am open to other
suggestions.
> I realise I'm only being picky about this because I'm not the one
> who has to work out how to do it :P
Sure, but changing the layout is a matter of seconds.
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-10 10:21 ` Christian Faulhammer
@ 2009-04-10 11:16 ` Ciaran McCreesh
2009-04-10 17:28 ` Christian Faulhammer
0 siblings, 1 reply; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-10 11:16 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1595 bytes --]
On Fri, 10 Apr 2009 12:21:36 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> > On Thu, 9 Apr 2009 19:16:34 +0200
> > Christian Faulhammer <fauli@gentoo.org> wrote:
> > > Attached is a PDF file with always two pages of one layout
> > > type. A margin note label is found in every example. Number of
> > > pages for the whole PMS in the following order:
> >
> > Mmm. Is part of the problem that we're not using a book style
> > layout? How does it look if we go for even-odd pages, with narrow
> > outside margins but larger inner margins, with labels always shown
> > on the inner margins?
>
> You confuse outside and inside here. Both inner margins are as wide
> as one outer margin. For the PMS one-sided is perfect as people will
> print it out one-sided, so the unequal margins would just look odd.
> Layout 2 and 3 are the ones I favour, but I am open to other
> suggestions.
By inner / outer, I probably mean even / odd or something. As a
picture, something like:
+-----------+-----------+
| aaaaaaa | aaaaaaa |
| aaaaaaa l | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | l aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
+-----------+-----------+
where l is our labels.
Big gap down the middle where the spine / two-up printing is, narrow
gap on the outside.
I suspect most people who print it out will be printing it out two-up
anyway.
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-10 11:16 ` Ciaran McCreesh
@ 2009-04-10 17:28 ` Christian Faulhammer
2009-04-10 18:08 ` Ciaran McCreesh
0 siblings, 1 reply; 19+ messages in thread
From: Christian Faulhammer @ 2009-04-10 17:28 UTC (permalink / raw
To: Ciaran McCreesh; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 2826 bytes --]
Hi,
Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Fri, 10 Apr 2009 12:21:36 +0200
> Christian Faulhammer <fauli@gentoo.org> wrote:
> > Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> > > On Thu, 9 Apr 2009 19:16:34 +0200
> > > Christian Faulhammer <fauli@gentoo.org> wrote:
> > > > Attached is a PDF file with always two pages of one layout
> > > > type. A margin note label is found in every example. Number of
> > > > pages for the whole PMS in the following order:
> > >
> > > Mmm. Is part of the problem that we're not using a book style
> > > layout? How does it look if we go for even-odd pages, with narrow
> > > outside margins but larger inner margins, with labels always shown
> > > on the inner margins?
> >
> > You confuse outside and inside here. Both inner margins are as
> > wide as one outer margin. For the PMS one-sided is perfect as
> > people will print it out one-sided, so the unequal margins would
> > just look odd. Layout 2 and 3 are the ones I favour, but I am open
> > to other suggestions.
>
> By inner / outer, I probably mean even / odd or something. As a
> picture, something like:
>
> +-----------+-----------+
> | aaaaaaa | aaaaaaa |
> | aaaaaaa l | aaaaaaa |
> | aaaaaaa | aaaaaaa |
> | aaaaaaa | aaaaaaa |
> | aaaaaaa | l aaaaaaa |
> | aaaaaaa | aaaaaaa |
> | aaaaaaa | aaaaaaa |
> | aaaaaaa | aaaaaaa |
> +-----------+-----------+
A standard two-page layout looks like this
+----------+----------+
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| aaaaaaa | aaaaaaa |
| | |
+----------+----------+
But I think I will go away from the calculated page layouts defined by
typearea.sty. It uses the golden ratio (see
<URL:http://en.wikipedia.org/wiki/Canons_of_page_construction>, you
will find two-page layouts there, too), which is great, but I will adapt
it for our needs. So near to a canon, one-sided and with a bigger outer
(right margin).
> Big gap down the middle where the spine / two-up printing is, narrow
> gap on the outside.
Which is not the classical canon, but the reverse, caused by two-up
printing in the wrong order (see below).
> I suspect most people who print it out will be printing it out two-up
> anyway.
Maybe, but it is still a one-page layout I prefer, as people don't
print right pages on the right but left ones, so using a two-page
layout is useless here.
V-Li
--
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode
<URL:http://gentoo.faulhammer.org/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [gentoo-pms] EAPI cheat sheet (for review)
2009-04-10 17:28 ` Christian Faulhammer
@ 2009-04-10 18:08 ` Ciaran McCreesh
0 siblings, 0 replies; 19+ messages in thread
From: Ciaran McCreesh @ 2009-04-10 18:08 UTC (permalink / raw
To: Christian Faulhammer; +Cc: gentoo-pms
[-- Attachment #1: Type: text/plain, Size: 1092 bytes --]
On Fri, 10 Apr 2009 19:28:26 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> But I think I will go away from the calculated page layouts defined
> by typearea.sty. It uses the golden ratio (see
> <URL:http://en.wikipedia.org/wiki/Canons_of_page_construction>, you
> will find two-page layouts there, too), which is great, but I will
> adapt it for our needs. So near to a canon, one-sided and with a
> bigger outer (right margin).
I've switched the eapi-3 draft to use book rather than article for now
so that the margin labels are more or less readable. That's just a
temporary thing, it's still yours to play with.
I've pushed what I've done so far to [1]. The labels should be more or
less complete; I'm going through and reviewing all the EAPI 3 stuff and
fixing as many of the TODOs as I can next, so there'll still be lots of
rebasing. If you find time to come up with any better formatting, I can
apply normal patches if you'd rather not work out how to make git do
your bidding.
[1]: http://github.com/ciaranm/pms/tree/eapi-3
--
Ciaran McCreesh
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
end of thread, other threads:[~2009-04-10 18:09 UTC | newest]
Thread overview: 19+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-04-01 16:05 [gentoo-pms] EAPI cheat sheet (for review) Christian Faulhammer
2009-04-03 22:20 ` Christian Faulhammer
2009-04-03 22:56 ` Ciaran McCreesh
2009-04-04 0:12 ` Christian Faulhammer
2009-04-04 15:48 ` Ciaran McCreesh
2009-04-04 19:33 ` Christian Faulhammer
2009-04-04 19:52 ` Ciaran McCreesh
2009-04-04 20:14 ` Christian Faulhammer
2009-04-04 20:23 ` Ciaran McCreesh
2009-04-05 19:21 ` Christian Faulhammer
2009-04-07 17:39 ` Ciaran McCreesh
2009-04-08 23:05 ` Christian Faulhammer
2009-04-08 23:09 ` Ciaran McCreesh
2009-04-09 17:16 ` Christian Faulhammer
2009-04-09 18:15 ` Ciaran McCreesh
2009-04-10 10:21 ` Christian Faulhammer
2009-04-10 11:16 ` Ciaran McCreesh
2009-04-10 17:28 ` Christian Faulhammer
2009-04-10 18:08 ` Ciaran McCreesh
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox