From: "André Erdmann" <dywi@mailerd.de>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/R_overlay:master commit in: doc/rst/, doc/html/
Date: Mon, 26 Jan 2015 17:41:02 +0000 (UTC) [thread overview]
Message-ID: <1422293636.5a767d95450d48aed547234114c486142d97186b.dywi@gentoo> (raw)
commit: 5a767d95450d48aed547234114c486142d97186b
Author: André Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Tue Dec 16 00:42:40 2014 +0000
Commit: André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Mon Jan 26 17:33:56 2015 +0000
URL: http://sources.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=5a767d95
doc/, hook env: document stdin==/dev/null
---
doc/html/usage.html | 38 ++++++++++++++++++++++++++++++--------
doc/rst/usage.rst | 9 ++++++++-
2 files changed, 38 insertions(+), 9 deletions(-)
diff --git a/doc/html/usage.html b/doc/html/usage.html
index a8075cb..440896e 100644
--- a/doc/html/usage.html
+++ b/doc/html/usage.html
@@ -3,13 +3,13 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.10: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>Automatically Generated Overlay of R packages</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 7514 2012-09-14 14:27:12Z milde $
+:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
@@ -313,6 +313,21 @@ table.docutils th.field-name, table.docinfo th.docinfo-name {
white-space: nowrap ;
padding-left: 0 }
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
@@ -2740,7 +2755,10 @@ successful overlay creation, which can be used to perform additional actions
without touching <em>roverlay's</em> source code.</p>
<p>To realize this, <em>roverlay</em> determines whether a given event is permitted
(<a class="reference internal" href="#event-policy">event policy</a>) and, if so, creates a <a class="reference internal" href="#hook-environment">hook environment</a> and runs the
-script. Additionally, shell scripts can load <em>roverlay's</em> <em>$FUNCTIONS</em> file,
+script.
+As these scripts are supposed to be non-interactive,
+<em>stdin</em> gets redirected to <tt class="docutils literal">/dev/null</tt>, except for <em>user</em>-event hooks.
+Additionally, shell scripts can load <em>roverlay's</em> <em>$FUNCTIONS</em> file,
which provides extra functionality.</p>
<div class="note">
<p class="first admonition-title">Note</p>
@@ -2812,7 +2830,7 @@ template gives an idea of how to write them:</p>
</span>
<span class="comment"># the script must not exit if everything went well (return is ok)
-</span><span class="keyword">return </span>0
+</span><span class="keyword">return</span> 0
</pre>
</div>
</div>
@@ -3193,8 +3211,8 @@ They should, however, not execute any code directly.</p>
<pre class="code sh literal-block">
<span class="comment"># protect against repeated inclusion of this file
# (replace <name> with a unique identifier)
-</span><span class="keyword">if</span> <span class="operator">[</span> -z <span class="literal string double">"${__HAVE_<name>__-}"</span> <span class="operator">]</span>; <span class="keyword">then
-</span><span class="name builtin">readonly </span>__HAVE_<name>__<span class="operator">=</span>y
+</span><span class="keyword">if</span> <span class="operator">[</span> -z <span class="literal string double">"${__HAVE_<name>__-}"</span> <span class="operator">]</span><span class="punctuation">;</span> <span class="keyword">then</span>
+<span class="name builtin">readonly </span>__HAVE_<name>__<span class="operator">=</span>y
<span class="comment"># function file body
# ...
@@ -3229,7 +3247,11 @@ They should, however, not execute any code directly.</p>
</tr>
<tr><td>user</td>
<td>unchanged</td>
-<td>user-triggered event</td>
+<td><p class="first">user-triggered event</p>
+<p class="last">This is the only event for
+which stdin does not get
+redirected.</p>
+</td>
</tr>
</tbody>
</table>
@@ -5146,7 +5168,7 @@ becomes "loop until resolver closes".</p>
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2014-08-23.
+Generated on: 2015-01-26.
</div>
</body>
diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst
index c6046c0..78acdff 100644
--- a/doc/rst/usage.rst
+++ b/doc/rst/usage.rst
@@ -2360,7 +2360,10 @@ without touching *roverlay's* source code.
To realize this, *roverlay* determines whether a given event is permitted
(`event policy`_) and, if so, creates a `hook environment`_ and runs the
-script. Additionally, shell scripts can load *roverlay's* *$FUNCTIONS* file,
+script.
+As these scripts are supposed to be non-interactive,
+*stdin* gets redirected to ``/dev/null``, except for *user*-event hooks.
+Additionally, shell scripts can load *roverlay's* *$FUNCTIONS* file,
which provides extra functionality.
.. Note::
@@ -2772,6 +2775,10 @@ The following table lists all known events (``ROVERLAY_PHASE``):
| db_written | *$OVERLAY* | stats database file written |
+-------------------+---------------------------+------------------------------+
| user | unchanged | user-triggered event |
+ | | | |
+ | | | This is the only event for |
+ | | | which stdin does not get |
+ | | | redirected. |
+-------------------+---------------------------+------------------------------+
next reply other threads:[~2015-01-26 17:41 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-26 17:41 André Erdmann [this message]
-- strict thread matches above, loose matches on Subject: below --
2014-02-21 17:36 [gentoo-commits] proj/R_overlay:master commit in: doc/rst/, doc/html/ André Erdmann
2013-09-26 22:34 André Erdmann
2013-09-23 15:30 André Erdmann
2013-09-06 11:10 André Erdmann
2013-08-29 12:36 André Erdmann
2013-08-20 7:50 André Erdmann
2013-06-05 18:11 [gentoo-commits] proj/R_overlay:gsoc13/next " André Erdmann
2013-06-13 16:34 ` [gentoo-commits] proj/R_overlay:master " André Erdmann
2012-08-20 14:04 André Erdmann
2012-08-13 16:34 André Erdmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1422293636.5a767d95450d48aed547234114c486142d97186b.dywi@gentoo \
--to=dywi@mailerd.de \
--cc=gentoo-commits@lists.gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox