aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 22:19:40 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 22:19:40 +0000
commita5df6da061061a55aef42642e90cca8748636e7e (patch)
tree90815f0163559ee0a8e0bd9ab2a679e431f4a42d
parent2d8a8fc45833a532a8b37f025c79a59c308f8b4c (diff)
downloadpaludis-a5df6da061061a55aef42642e90cca8748636e7e.tar.gz
paludis-a5df6da061061a55aef42642e90cca8748636e7e.tar.xz
bashrc
-rw-r--r--doc/configuration/Makefile.am29
-rw-r--r--doc/configuration/bashrc.html.part.in30
2 files changed, 51 insertions, 8 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 31f1bf9..d730140 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -19,14 +19,16 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
environment.html.part \
keywords.html \
keywords.html.part \
- package_mask.html \
- package_mask.html.part \
+ packagemask.html \
+ packagemask.html.part \
use.html \
use.html.part \
licenses.html \
licenses.html.part \
mirrors.html \
mirrors.html.part \
+ bashrc.html \
+ bashrc.html.part \
configfiles.html \
specs.html
@@ -42,8 +44,9 @@ EXTRA_DIST = \
specpath.html.part.in \
environment.html.part.in \
keywords.html.part.in \
- package_mask.html.part.in \
+ packagemask.html.part.in \
mirrors.html.part.in \
+ bashrc.html.part.in \
use.html.part.in \
paludisenvironmentonly.html.part \
configfiles.html.part \
@@ -60,8 +63,9 @@ paludisconfigurationhtml_DATA = \
specpath.html \
environment.html \
keywords.html \
- package_mask.html \
+ packagemask.html \
mirrors.html \
+ bashrc.html \
licenses.html \
use.html \
configfiles.html \
@@ -141,11 +145,11 @@ keywords.html.part : $(srcdir)/keywords.html.part.in $(srcdir)/paludisenvironmen
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/keywords.html.part.in > keywords.html.part
-package_mask.html.part : $(srcdir)/package_mask.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+packagemask.html.part : $(srcdir)/packagemask.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
- < $(srcdir)/package_mask.html.part.in > package_mask.html.part
+ < $(srcdir)/packagemask.html.part.in > packagemask.html.part
mirrors.html.part : $(srcdir)/mirrors.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
@@ -153,6 +157,12 @@ mirrors.html.part : $(srcdir)/mirrors.html.part.in $(srcdir)/paludisenvironmento
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/mirrors.html.part.in > mirrors.html.part
+bashrc.html.part : $(srcdir)/bashrc.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/bashrc.html.part.in > bashrc.html.part
+
licenses.html.part : $(srcdir)/licenses.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -177,12 +187,15 @@ environment.html : header.html.part environment.html.part footer.html.part
keywords.html : header.html.part keywords.html.part footer.html.part
cat header.html.part keywords.html.part footer.html.part > $@
-package_mask.html : header.html.part package_mask.html.part footer.html.part
- cat header.html.part package_mask.html.part footer.html.part > $@
+packagemask.html : header.html.part packagemask.html.part footer.html.part
+ cat header.html.part packagemask.html.part footer.html.part > $@
mirrors.html : header.html.part mirrors.html.part footer.html.part
cat header.html.part mirrors.html.part footer.html.part > $@
+bashrc.html : header.html.part bashrc.html.part footer.html.part
+ cat header.html.part bashrc.html.part footer.html.part > $@
+
licenses.html : header.html.part licenses.html.part footer.html.part
cat header.html.part licenses.html.part footer.html.part > $@
diff --git a/doc/configuration/bashrc.html.part.in b/doc/configuration/bashrc.html.part.in
new file mode 100644
index 0000000..20ec9b9
--- /dev/null
+++ b/doc/configuration/bashrc.html.part.in
@@ -0,0 +1,30 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>bashrc</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>The <code>bashrc</code> file is sourced by Paludis when executing most bash scripts (for example, ebuilds and
+syncers). It can be used to set build-related options (e.g. <code>CFLAGS</code>), but <strong>not</strong> any
+option which might affect dependency resolution (e.g. <code>USE</code>).</p>
+
+<p>This file must not be used to output anything to standard output. Be aware that sandbox and / or reduced privileges
+may be in operation.</p>
+
+<h2>Example</h2>
+
+<pre>
+# Set basic build options
+CFLAGS="-O2 -march=pentium4 -fomit-frame-pointer"
+CXXFLAGS="${CFLAGS}"
+MAKEOPTS="-j2"
+
+# For some profiles, you <strong>must</strong> set CHOST
+CHOST="i686-pc-linux-gnu"
+
+# We have access to CATEGORY, PN etc, which we can use for per-package settings
+if [[ "${CATEGORY}/${PN}" == "sys-apps/paludis" ]] ; then
+ CXXFLAGS="${CXXFLAGS} -g -ggdb3"
+fi
+</pre>
+