← Back to branch summary

~ubuntu-branches/ubuntu/lucid/cedar-backup2/lucid

« back to all changes in this revision

Viewing changes to doc/interface/CedarBackup2.actions.stage-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2009-03-29 15:00:28 UTC
  • mfrom: (1.1.10 upstream) (4.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090329150028-ljhfp6mxplcbmx4i
Tags: 2.19.3-1
* New upstream release.
* Remove references to user manual PDF (no longer shipped).
* Update debian/copyright based on new upstream CREDITS.
* Bump standards version to 3.8.1 (no packaging changes).
* Bump debhelper compatibility to 7, per linitian recommendation.
* Declare a dependency on debhelper (>= 7.0.1) to match compatibility.
* Reference /usr/share/common-licenses/GPL-2 rather than just GPL.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/interface/CedarBackup2.actions.stage-module.html
61
61
  </tr>
62
62
</table>
63
63
<!-- ==================== MODULE DESCRIPTION ==================== -->
64
 
<h1 class="epydoc">Module stage</h1><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html">source&nbsp;code</a></span><br /><br />
65
 
Implements the standard 'stage' action.<br /><br />
 
64
<h1 class="epydoc">Module stage</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html">source&nbsp;code</a></span></p>
 
65
<p>Implements the standard 'stage' action.</p>
66
66
 
67
67
<hr />
68
68
<div class="fields">      <p><strong>Author:</strong>
110
110
    </td><td class="summary">
111
111
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
112
112
        <tr>
113
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_createStagingDirs" class="summary-sig-name">_createStagingDirs</a>(<span class="summary-sig-arg">config</span>,
 
113
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_createStagingDirs" class="summary-sig-name" onclick="show_private();">_createStagingDirs</a>(<span class="summary-sig-arg">config</span>,
114
114
        <span class="summary-sig-arg">dailyDir</span>,
115
115
        <span class="summary-sig-arg">peers</span>)</span><br />
116
116
      Creates staging directories as required.</td>
129
129
    </td><td class="summary">
130
130
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
131
131
        <tr>
132
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getIgnoreFailuresFlag" class="summary-sig-name">_getIgnoreFailuresFlag</a>(<span class="summary-sig-arg">options</span>,
 
132
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getIgnoreFailuresFlag" class="summary-sig-name" onclick="show_private();">_getIgnoreFailuresFlag</a>(<span class="summary-sig-arg">options</span>,
133
133
        <span class="summary-sig-arg">config</span>,
134
134
        <span class="summary-sig-arg">peer</span>)</span><br />
135
 
      Gets the ignore failures flag based on options, configuration, and
 
135
      Gets the ignore failures flag based on options, configuration, and 
136
136
      peer.</td>
137
137
          <td align="right" valign="top">
138
138
            <span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getIgnoreFailuresFlag">source&nbsp;code</a></span>
149
149
    </td><td class="summary">
150
150
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
151
151
        <tr>
152
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getDailyDir" class="summary-sig-name">_getDailyDir</a>(<span class="summary-sig-arg">config</span>)</span><br />
 
152
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getDailyDir" class="summary-sig-name" onclick="show_private();">_getDailyDir</a>(<span class="summary-sig-arg">config</span>)</span><br />
153
153
      Gets the daily staging directory.</td>
154
154
          <td align="right" valign="top">
155
155
            <span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getDailyDir">source&nbsp;code</a></span>
166
166
    </td><td class="summary">
167
167
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
168
168
        <tr>
169
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getLocalPeers" class="summary-sig-name">_getLocalPeers</a>(<span class="summary-sig-arg">config</span>)</span><br />
 
169
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getLocalPeers" class="summary-sig-name" onclick="show_private();">_getLocalPeers</a>(<span class="summary-sig-arg">config</span>)</span><br />
170
170
      Return a list of <a href="CedarBackup2.peer.LocalPeer-class.html" 
171
171
      class="link">LocalPeer</a> objects based on configuration.</td>
172
172
          <td align="right" valign="top">
184
184
    </td><td class="summary">
185
185
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
186
186
        <tr>
187
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getRemotePeers" class="summary-sig-name">_getRemotePeers</a>(<span class="summary-sig-arg">config</span>)</span><br />
188
 
      Return a list of <a href="CedarBackup2.peer.RemotePeer-class.html"
 
187
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getRemotePeers" class="summary-sig-name" onclick="show_private();">_getRemotePeers</a>(<span class="summary-sig-arg">config</span>)</span><br />
 
188
      Return a list of <a href="CedarBackup2.peer.RemotePeer-class.html" 
189
189
      class="link">RemotePeer</a> objects based on configuration.</td>
190
190
          <td align="right" valign="top">
191
191
            <span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getRemotePeers">source&nbsp;code</a></span>
202
202
    </td><td class="summary">
203
203
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
204
204
        <tr>
205
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getRemoteUser" class="summary-sig-name">_getRemoteUser</a>(<span class="summary-sig-arg">config</span>,
 
205
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getRemoteUser" class="summary-sig-name" onclick="show_private();">_getRemoteUser</a>(<span class="summary-sig-arg">config</span>,
206
206
        <span class="summary-sig-arg">remotePeer</span>)</span><br />
207
207
      Gets the remote user associated with a remote peer.</td>
208
208
          <td align="right" valign="top">
220
220
    </td><td class="summary">
221
221
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
222
222
        <tr>
223
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getLocalUser" class="summary-sig-name">_getLocalUser</a>(<span class="summary-sig-arg">config</span>)</span><br />
 
223
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getLocalUser" class="summary-sig-name" onclick="show_private();">_getLocalUser</a>(<span class="summary-sig-arg">config</span>)</span><br />
224
224
      Gets the remote user associated with a remote peer.</td>
225
225
          <td align="right" valign="top">
226
226
            <span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getLocalUser">source&nbsp;code</a></span>
237
237
    </td><td class="summary">
238
238
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
239
239
        <tr>
240
 
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getRcpCommand" class="summary-sig-name">_getRcpCommand</a>(<span class="summary-sig-arg">config</span>,
 
240
          <td><span class="summary-sig"><a href="CedarBackup2.actions.stage-module.html#_getRcpCommand" class="summary-sig-name" onclick="show_private();">_getRcpCommand</a>(<span class="summary-sig-arg">config</span>,
241
241
        <span class="summary-sig-arg">remotePeer</span>)</span><br />
242
242
      Gets the RCP command associated with a remote peer.</td>
243
243
          <td align="right" valign="top">
307
307
  </td><td align="right" valign="top"
308
308
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#executeStage">source&nbsp;code</a></span>&nbsp;
309
309
    </td>
310
 
  </table>
 
310
  </tr></table>
311
311
  
312
 
  Executes the stage backup action.
 
312
  <p>Executes the stage backup action.</p>
313
313
  <dl class="fields">
314
314
    <dt>Parameters:</dt>
315
315
    <dd><ul class="nomargin-top">
326
326
<div class="fields">      <strong>Notes:</strong>
327
327
      <ul class="nomargin-top">
328
328
        <li>
329
 
        The daily directory is derived once and then we stick with it, 
330
 
        just in case a backup happens to span midnite.
 
329
        The daily directory is derived once and then we stick with it, just
 
330
        in case a backup happens to span midnite.
331
331
        </li>
332
332
        <li>
333
 
        As portions of the stage action is complete, we will write 
334
 
        various indicator files so that it's obvious what actions have been
 
333
        As portions of the stage action is complete, we will write various 
 
334
        indicator files so that it's obvious what actions have been 
335
335
        completed.  Each peer gets a stage indicator in its collect 
336
336
        directory, and then the master gets a stage indicator in its daily 
337
337
        staging directory.  The store process uses the master's stage 
356
356
  </td><td align="right" valign="top"
357
357
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_createStagingDirs">source&nbsp;code</a></span>&nbsp;
358
358
    </td>
359
 
  </table>
 
359
  </tr></table>
360
360
  
361
361
  <p>Creates staging directories as required.</p>
362
 
  The main staging directory is the passed in daily directory, something
 
362
  <p>The main staging directory is the passed in daily directory, something
363
363
  like <code>staging/2002/05/23</code>.  Then, individual peers get their 
364
 
  own directories, i.e. <code>staging/2002/05/23/host</code>.
 
364
  own directories, i.e. <code>staging/2002/05/23/host</code>.</p>
365
365
  <dl class="fields">
366
366
    <dt>Parameters:</dt>
367
367
    <dd><ul class="nomargin-top">
388
388
  </td><td align="right" valign="top"
389
389
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getIgnoreFailuresFlag">source&nbsp;code</a></span>&nbsp;
390
390
    </td>
391
 
  </table>
 
391
  </tr></table>
392
392
  
393
 
  Gets the ignore failures flag based on options, configuration, and 
394
 
  peer.
 
393
  <p>Gets the ignore failures flag based on options, configuration, and 
 
394
  peer.</p>
395
395
  <dl class="fields">
396
396
    <dt>Parameters:</dt>
397
397
    <dd><ul class="nomargin-top">
416
416
  </td><td align="right" valign="top"
417
417
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getDailyDir">source&nbsp;code</a></span>&nbsp;
418
418
    </td>
419
 
  </table>
 
419
  </tr></table>
420
420
  
421
421
  <p>Gets the daily staging directory.</p>
422
 
  This is just a directory in the form <code>staging/YYYY/MM/DD</code>, 
 
422
  <p>This is just a directory in the form <code>staging/YYYY/MM/DD</code>, 
423
423
  i.e. <code>staging/2000/10/07</code>, except it will be an absolute path 
424
 
  based on <code>config.stage.targetDir</code>.
 
424
  based on <code>config.stage.targetDir</code>.</p>
425
425
  <dl class="fields">
426
426
    <dt>Parameters:</dt>
427
427
    <dd><ul class="nomargin-top">
444
444
  </td><td align="right" valign="top"
445
445
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getLocalPeers">source&nbsp;code</a></span>&nbsp;
446
446
    </td>
447
 
  </table>
 
447
  </tr></table>
448
448
  
449
 
  Return a list of <a href="CedarBackup2.peer.LocalPeer-class.html" 
450
 
  class="link">LocalPeer</a> objects based on configuration.
 
449
  <p>Return a list of <a href="CedarBackup2.peer.LocalPeer-class.html" 
 
450
  class="link">LocalPeer</a> objects based on configuration.</p>
451
451
  <dl class="fields">
452
452
    <dt>Parameters:</dt>
453
453
    <dd><ul class="nomargin-top">
471
471
  </td><td align="right" valign="top"
472
472
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getRemotePeers">source&nbsp;code</a></span>&nbsp;
473
473
    </td>
474
 
  </table>
 
474
  </tr></table>
475
475
  
476
 
  Return a list of <a href="CedarBackup2.peer.RemotePeer-class.html" 
477
 
  class="link">RemotePeer</a> objects based on configuration.
 
476
  <p>Return a list of <a href="CedarBackup2.peer.RemotePeer-class.html" 
 
477
  class="link">RemotePeer</a> objects based on configuration.</p>
478
478
  <dl class="fields">
479
479
    <dt>Parameters:</dt>
480
480
    <dd><ul class="nomargin-top">
499
499
  </td><td align="right" valign="top"
500
500
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getRemoteUser">source&nbsp;code</a></span>&nbsp;
501
501
    </td>
502
 
  </table>
 
502
  </tr></table>
503
503
  
504
 
  Gets the remote user associated with a remote peer. Use peer's if 
505
 
  possible, otherwise take from options section.
 
504
  <p>Gets the remote user associated with a remote peer. Use peer's if 
 
505
  possible, otherwise take from options section.</p>
506
506
  <dl class="fields">
507
507
    <dt>Parameters:</dt>
508
508
    <dd><ul class="nomargin-top">
526
526
  </td><td align="right" valign="top"
527
527
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getLocalUser">source&nbsp;code</a></span>&nbsp;
528
528
    </td>
529
 
  </table>
 
529
  </tr></table>
530
530
  
531
 
  Gets the remote user associated with a remote peer.
 
531
  <p>Gets the remote user associated with a remote peer.</p>
532
532
  <dl class="fields">
533
533
    <dt>Parameters:</dt>
534
534
    <dd><ul class="nomargin-top">
552
552
  </td><td align="right" valign="top"
553
553
    ><span class="codelink"><a href="CedarBackup2.actions.stage-pysrc.html#_getRcpCommand">source&nbsp;code</a></span>&nbsp;
554
554
    </td>
555
 
  </table>
 
555
  </tr></table>
556
556
  
557
 
  Gets the RCP command associated with a remote peer. Use peer's if 
558
 
  possible, otherwise take from options section.
 
557
  <p>Gets the RCP command associated with a remote peer. Use peer's if 
 
558
  possible, otherwise take from options section.</p>
559
559
  <dl class="fields">
560
560
    <dt>Parameters:</dt>
561
561
    <dd><ul class="nomargin-top">
599
599
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
600
600
  <tr>
601
601
    <td align="left" class="footer">
602
 
    Generated by Epydoc 3.0beta1 on Sat Nov 15 12:16:52 2008
 
602
    Generated by Epydoc 3.0.1 on Sun Mar 29 14:50:16 2009
603
603
    </td>
604
604
    <td align="right" class="footer">
605
 
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
605
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
606
        >http://epydoc.sourceforge.net</a>
606
607
    </td>
607
608
  </tr>
608
609
</table>
613
614
  // javascript is turned off then we want them to be
614
615
  // visible); but by default, we want to hide them.  So hide
615
616
  // them unless we have a cookie that says to show them.
616
 
  checkCookie()
 
617
  checkCookie();
617
618
  // -->
618
619
</script>
619
 
  
620
620
</body>
621
621
</html>