/usr/share/doc/drobo-utils/DEVELOPERS.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.6: http://docutils.sourceforge.net/" />
<title>DEVELOPERS NOTES</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left{
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: left }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="developers-notes">
<h1 class="title">DEVELOPERS NOTES</h1>

<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#working-with-source" id="id1">Working With Source</a></li>
<li><a class="reference internal" href="#getting-a-source-tree" id="id2">Getting a Source Tree</a></li>
<li><a class="reference internal" href="#git-configure-patch-author" id="id3">GIT Configure Patch Author</a></li>
<li><a class="reference internal" href="#using-a-source-snapshot" id="id4">Using a Source Snapshot</a></li>
<li><a class="reference internal" href="#dpkg-vs-python-install" id="id5">Dpkg vs. Python Install</a></li>
<li><a class="reference internal" href="#making-a-release" id="id6">Making a Release</a><ul>
<li><a class="reference internal" href="#quality-assurance-qa-txt" id="id7">Quality Assurance (QA.txt)</a></li>
<li><a class="reference internal" href="#building-debian-ubuntu-packages" id="id8">Building Debian &amp; Ubuntu Packages</a></li>
</ul>
</li>
<li><a class="reference internal" href="#updating-documentation" id="id9">Updating Documentation</a></li>
<li><a class="reference internal" href="#droboshare" id="id10">Droboshare</a><ul>
<li><a class="reference internal" href="#open-task-reverse-engineer-dashboard-droboshare-protocol" id="id11">Open Task: Reverse Engineer Dashboard &lt;-&gt; Droboshare Protocol</a></li>
<li><a class="reference internal" href="#building-darfs" id="id12">Building DARFS</a></li>
</ul>
</li>
<li><a class="reference internal" href="#todo" id="id13">TODO</a></li>
<li><a class="reference internal" href="#administrivia" id="id14">Administrivia</a></li>
</ul>
</div>
<p>This software is copyright under GPL.  See near end file for details...</p>
<p>Random useful bits for developers.  (aka notes to myself ;-)</p>
<div class="section" id="working-with-source">
<h1><a class="toc-backref" href="#id1">Working With Source</a></h1>
<p>Project Source code is managed using a git repository provided by sourceforge.net.
Git ( <a class="reference external" href="http://git-scm.com/">http://git-scm.com/</a> ) provides a fully distributed development model,
so one can exchange patches arbitrarily among developers.  On the sf.net repository, the 'master' branch is the final integration target for future releases.</p>
</div>
<div class="section" id="getting-a-source-tree">
<h1><a class="toc-backref" href="#id2">Getting a Source Tree</a></h1>
<p>the following checks out the master branch of the source code tree and
puts it in the drobo-utils subdirectory of the current tree.</p>
<p>git clone <a class="reference external" href="ssh://peter_silva&#64;drobo-utils.git.sourceforge.net/gitroot/drobo-utils/drobo-utils">ssh://peter_silva&#64;drobo-utils.git.sourceforge.net/gitroot/drobo-utils/drobo-utils</a> drobo-utils</p>
<p>Before doing Any commits, ensure that the author fields are appropriately set.</p>
<p>One can obtain patches applied to the branch with git pull, and commit patches for distribution with git push.</p>
</div>
<div class="section" id="git-configure-patch-author">
<h1><a class="toc-backref" href="#id3">GIT Configure Patch Author</a></h1>
<p>To ensure the correct author on patches created, make sure to set your author settings.
Something like the following is appropriate if you use a single identity for all your code contributions.</p>
<blockquote>
boule% git config --global user.name &quot;firstname lastname&quot;
boule% git config --global user.email &quot;<a class="reference external" href="mailto:developer&#64;sourceforge.net">developer&#64;sourceforge.net</a>&quot;
boule%</blockquote>
<p>Others may wish for the identity to be associated with each project.</p>
</div>
<div class="section" id="using-a-source-snapshot">
<h1><a class="toc-backref" href="#id4">Using a Source Snapshot</a></h1>
<p>Sometimes, when there are issues, the correction gets checked in, but there
hasn't been time to do a full release process.  If you really need the fix,
then your only option is to get it from the developers' git repository.
If you are told 'it is in git', that refers to the git source code management
system, and the server for that is at sourceforge.net.  How to get it:</p>
<pre class="literal-block">
# git clone ssh://developer&#64;drobo-utils.git.sourceforge.net/gitroot/drobo-utils/drobo-utils mine
# cd mine                 # go into the source directory you downloaded
# ./drobom status         # try it out...
# python setup.py install # install it in system places...
# drobom status           # try it out...
# git pull # get any changes made since the git clone was done.
# python setup.py install # install the changes in system places.
</pre>
<p>Sample checkout of a stable version.  To view available branches:</p>
<pre class="literal-block">
% git branch -r
origin/HEAD -&gt; origin/master
origin/master
origin/noC
origin/peter
origin/r0.2.1
origin/r0_3_3
origin/r0_4_0
origin/r0_5_0
origin/r0_6_0
</pre>
<p>Where a version is something like r0_4_0.  then you can pick anyone to work with:</p>
<pre class="literal-block">
% git branch r0_4_0 -r origin/r0_4_0
Branch r0_4_0 set up to track remote branch r0_4_0 from origin.
% git checkout r0_4_0
Switched to branch 'r0_4_0'
%
</pre>
<p>When you use git to get a tree, it keeps copies of metadata to be able to
track changes.  If you want a copy that is contains no git cruft,
rm -rf .git in the root of the source tree.</p>
<p>If you are mixing downloaded packages and source installs, check out the next
section for gotchas.</p>
</div>
<div class="section" id="dpkg-vs-python-install">
<h1><a class="toc-backref" href="#id5">Dpkg vs. Python Install</a></h1>
<p>The 'setup.py' script, mentioned in the previous section, is a convention
from the distutils python packaging system.  distutils installation is slightly
different from installation from debian packages.  There doesn't seem to be a
distutils way to remove a package. touch all the files, do an installation, then
manually remove the files it installed.</p>
<p>drobo-utils has been picked up for inclusion in debian.  The &quot;real&quot; packaging
for debian packages is kept in a separate tree, and maintained by debian
developers.</p>
<p>The debian/ setup puts stuff in /usr/sbin while setup.py puts things in /usr/bin.  Python install does not install man pages either, which the dpkg takes care of.  The libs are placed differently too.  haven't reviewed for other conflicts, least confusing to use one or the other method on a system.</p>
<p>(if you do distutils install, then remove the debian package via: dpkg --purge drobo-utils)</p>
</div>
<div class="section" id="making-a-release">
<h1><a class="toc-backref" href="#id6">Making a Release</a></h1>
<blockquote>
<dl class="docutils">
<dt>1 - make a branch</dt>
<dd># assuming you have a local repository...
git branch &lt;branch&gt;  # creates the branch, from the cwd (ought to be master)
git checkout &lt;branch&gt; # switches current dir to the branch.</dd>
<dt>2 - Stamp the branch with version</dt>
<dd>vi CHANGES.txt          # complete change manifest for release
vi debian/changelog     # copy manifest from txt, add signature.
vi setup.py             # edit version
vi Drobo.py             # edit VERSION</dd>
</dl>
<p>3 - Build packages for testing &amp; Install them. (see separate recipe.)</p>
<dl class="docutils">
<dt>4 - Run QA.</dt>
<dd>Record results of release tests in the branch (QA.txt) As new tests are created, modify QA.txt on trunk for to keep references for the next release.</dd>
</dl>
</blockquote>
<div class="section" id="quality-assurance-qa-txt">
<h2><a class="toc-backref" href="#id7">Quality Assurance (QA.txt)</a></h2>
<p>QA.txt is a quality assurance log.  The version on the trunk of the releases
indicates the QA procedure to be applied to the next version during the
release process.  Since a branch is created for each release, the version
of QA.txt acts as a quality log for that release.  so one can do an git
checkout, or git export to get the quality log for any release (QA.txt
introduce in version 0.4.0)</p>
</div>
<div class="section" id="building-debian-ubuntu-packages">
<h2><a class="toc-backref" href="#id8">Building Debian &amp; Ubuntu Packages</a></h2>
<p>Assumes you have installed the Build dependencies:</p>
<pre class="literal-block">
# obtain a fresh tree
% git clone ssh://peter_silva&#64;drobo-utils.git.sourceforge.net/gitroot/drobo-utils/&lt;version&gt; drobo-utils-&lt;version&gt;
% cd drobo-utils-&lt;version&gt;
% rm -rf .git  # get rid of Git cruft, yielding a raw source tree.
% chmod 755 debian/rules  # I dunno why the permissions are wrong...

# this debian/ config is just for non-distro packages.
# builds for debian and Ubuntu.

% dpkg-buildpackage -rfakeroot
% cd ..
# rename it for whatever distro is appropriate...
% mv drobo_utils_0.3.3-1_i386 --&gt; droboutils_0.3.3-1_i386_ubunutuIntrepid.deb

# rebuild the source tar because it will have the 'debian' link in it.
% cd drobo-utils-0.99.9
% rm debian
% cd ..
% tar -czvf drobo-utils-0.3.3-1.tgz drobo-utils-0.99.9
</pre>
<p>apply QA tests. as per QA.txt recording results there.</p>
</div>
</div>
<div class="section" id="updating-documentation">
<h1><a class="toc-backref" href="#id9">Updating Documentation</a></h1>
<p>use the restructured text tools (from the python-docutils package.)
to build things using:</p>
<blockquote>
% make doc</blockquote>
<p>Have a look at Makefile for how that works.
update the web site:</p>
<blockquote>
% scp README.html &lt;user&gt;,drobo-<a class="reference external" href="mailto:utils&#64;web.sourceforge.net">utils&#64;web.sourceforge.net</a>:htdocs</blockquote>
</div>
<div class="section" id="droboshare">
<h1><a class="toc-backref" href="#id10">Droboshare</a></h1>
<p>Droboshare is not directly supported by drobo utils running on a linux host.
However, the droboshare itself is a linux host, and it is possible to run
drobo-utils un-modified on the droboshare itself.  There is download called
the Droboshare Augmented Root File system (DARFS), which includes a python
interpreter and drobo-utils.</p>
<div class="section" id="open-task-reverse-engineer-dashboard-droboshare-protocol">
<h2><a class="toc-backref" href="#id11">Open Task: Reverse Engineer Dashboard &lt;-&gt; Droboshare Protocol</a></h2>
<p>Why isn't there full support in host based drobo-utils itself?  Digital
Robotics hasn't released details of the protocol used by the proprietary
dashboard to communicate with a droboshare, so it would be a lot of work to
reverse engineer that.  So support of a droboshare from a linux GUI on a
host system is not likely in the near future.</p>
<p>If someone wants to figure that out, it might be a good thing (tm)
After that is figured out, the next step would be to understand
how to flash the firmware remotely.  That would eliminate the last function
that cannot be done with open source.</p>
</div>
<div class="section" id="building-darfs">
<h2><a class="toc-backref" href="#id12">Building DARFS</a></h2>
<p>DARFS - Droboshare Augmented Root File System. A pile of stuff that can
be run on a droboshare.</p>
<p>Have a look here:</p>
<p><a class="reference external" href="http://groups.google.com/group/drobo-talk/web/building-droboshare-apps-on-debianish-os?hl=en">http://groups.google.com/group/drobo-talk/web/building-droboshare-apps-on-debianish-os?hl=en</a></p>
</div>
</div>
<div class="section" id="todo">
<h1><a class="toc-backref" href="#id13">TODO</a></h1>
<p>Tasks which would be cool to get done, in no particular order:</p>
<p>Option setting... especially for DroboPro IP Address &amp; netmask.</p>
<p>CentOS support.  Fedora is likely fine, but should build a VM with CentOS on it, and build an rpm.  RHEL has an ancient python (2.4?) with no ctypes by default, so could be interesting.</p>
<p>GUI - handle when Drobo disappears...</p>
<dl class="docutils">
<dt>Refuse known non-working feature bits... firmware (review 2009 SDK release)</dt>
<dd>Review feature bits, mis-marked? 28</dd>
<dt>Add Alerting to GUI &amp; CLI</dt>
<dd>-- save config...
.. SMTP forwarder:
.. address
.. authentication.? u+p
..</dd>
<dt>Droboshare bugs</dt>
<dd>-- don't dump diags to /tmp, they don't fit.
-- don't</dd>
<dt>BUGS:</dt>
<dd>when running two fw uploads, the second one will not run easily.
need to wait for transaction to timeout...  perhaps randomize id?
did randomization, did not change anything...</dd>
<dt>STANDARD menu entries for droboview...</dt>
<dd><dl class="first docutils">
<dt>partition types do not appear to be correctly displayed...</dt>
<dd>some confusion between NTFS vs. EXT3  no obvious ill effect.</dd>
</dl>
<p>partition type should pre-select in Format dialog...</p>
<p class="last">memory consumption on the GUI. still chews up 4 MB per hour...</p>
</dd>
<dt>gnats:</dt>
<dd>man page does not document output.
-- what is the meaning of the output? provide a sample...</dd>
<dt>review print statements:</dt>
<dd>should they write to stderr?</dd>
</dl>
<p>STANDARD menu entries for droboview...</p>
<dl class="docutils">
<dt>Better STATUS progress reporting:</dt>
<dd>-- the block count is there, but heuristics for determining timing suck.
-- some sort of indicator of how long 'relay out' will be in progress.
-- when it is busy, it should say so... like when I emptied an ntfs it took hours for the led indicators to drop from 70% to 0.  It should say something about what is going on.</dd>
<dt>LIVELIER GUI:</dt>
<dd><dl class="first last docutils">
<dt>-- have status queries proceed asynchronously from the GUI.</dt>
<dd>right now, if the drobo is slow, the GUI makes it slower, and gets very slow too.
should run as a daemon, async. from the GUI.</dd>
</dl>
</dd>
<dt>Re-design the whole darn thing.</dt>
<dd><p class="first">-- there should be some sort of service integrated with dbus-hal
-- not sure that a GUI is needed at all. but if it is, it should be a DBUS client.
-- how does authentication work in DBUS?</p>
<p class="last">of interest:
-- python bindings for parted... <a class="reference external" href="http://dcantrel.fedorapeople.org/pyparted/">http://dcantrel.fedorapeople.org/pyparted/</a></p>
</dd>
</dl>
<p>Revision date: 2009/05/19</p>
<p>copyright:</p>
<p>Drobo Utils Copyright (C) 2008,2009  Peter Silva (<a class="reference external" href="mailto:Peter.A.Silva&#64;gmail.com">Peter.A.Silva&#64;gmail.com</a>)
Drobo Utils comes with ABSOLUTELY NO WARRANTY; For details type see the file
named COPYING in the root of the source directory tree.</p>
</div>
<div class="section" id="administrivia">
<h1><a class="toc-backref" href="#id14">Administrivia</a></h1>
<blockquote>
version 0.6.1, October 6th 2009.</blockquote>
<p>copyright:</p>
<p>Drobo Utils Copyright (C) 2008  Peter Silva (<a class="reference external" href="mailto:Peter.A.Silva&#64;gmail.com">Peter.A.Silva&#64;gmail.com</a>)
Drobo Utils comes with ABSOLUTELY NO WARRANTY; For details type see the file
named COPYING in the root of the source directory tree.</p>
</div>
</div>
</body>
</html>
drobo-utils 0.6.1+repack-1 / usr / share / doc / drobo-utils / DEVELOPERS.html
