[docs] xmldocs - docelic modified 8 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Nov 3 14:08:25 EST 2004


User:      docelic
Date:      2004-11-03 19:08:25 GMT
Added:     pending  copyright.txt documented-sort newdevel
Added:              not-complicated.heh perl-calc.diff.txt
Added:              programming-style properrun release-notes.txt
Log:
- Various new extracts from newer -core posts (up to october 20,2004 or something).

Revision  Changes    Path
1.1                  xmldocs/pending/copyright.txt


rev 1.1, prev_rev 1.0
Index: copyright.txt
===================================================================
Interchange Development Group
Copyright notice policy
draft as of 2003-06-05

In the beginning there was Vend, written by Andrew M. Wilcox in 1995,
and licensed under the GNU General Public License. From this Mike Heins
wrote Minivend, starting in 1996. Mike was the main developer and thus
the copyright holder for Minivend through 2000, when he sold the software
ownership to Akopia in 2000, where it was renamed to Interchange. Akopia
sold ownership to Red Hat in 2001. Development continued primarily by
Red Hat until 2002, and ownership of code written until that time remains
with Red Hat.

Thus, all older code should retain this notice:

Copyright (C) 1996-2002 Red Hat, Inc.

The few files that still contain original Vend code should have this
additional notice:

Copyright (C) 1995 Andrew M. Wilcox

Probably that only applies to scripts/interchange.PL, lib/Vend/Config.pm,
and lib/Vend/Interpolate.pm, though Andrew's copyright is mentioned in
numerous other lib/Vend modules and certainly isn't hurting anything.
I believe all the documentation originates from Mike Heins directly, and
thus is owned primarily by Red Hat.

To the best of our knowledge, none of the code was licensed at any time
under any license other than the GNU General Public License, version 2
or later.  

Since the fall of 2002, Red Hat has not been in any way involved in
Interchange development, so no year later than 2002 should be assigned
to them in the copyright notice.

Anything that's been worked on since then, which is pretty much every 
single file in CVS, should have both an historical Red Hat copyright
notice as well as an Interchange Development Group notice, the latter
listed first since it's the most recent, and with its year range
expanding as time goes on. For example:

Copyright (C) 2003 Interchange Development Group
Copyright (C) 1996-2002 Red Hat, Inc.

The exact legal import of this notice is unclear, since the group isn't
a legal entity. But under common law we should be recognized as a group
acting as one in such matters. I think our case will be helped somewhat
by keeping a current list of our group members on the www.icdevgroup.org
website. So I'd say "Interchange Development Group" is an alias for
"all the individuals listed on the group membership page", at least
until something else is decided on.

Any brand new development that doesn't derive from the Mike Heins/
Akopia/Red Hat days can just have an Interchange Development Group
and/or personal notice:

Copyright (C) 2003 Interchange Development Group

I do not plan to put my own name in as a copyright holder, but if you 
wanted to, you could add yours like this:

Copyright (C) 2003 Interchange Development Group
Copyright (C) 2003 Freddy Frankenstein

Does it matter if individual developers put *only* their own names?
Probably not, if it's GPL-licensed, and we seem to have arrived on an
unwritten policy that everything in the cvs.icdevgroup.org CVS repository
must be under a free software license such as the GPL.


drafted by:
Jon Jensen

agreed to in principle by:
Dan Browning
Kevin Walsh



1.1                  xmldocs/pending/documented-sort


rev 1.1, prev_rev 1.0
Index: documented-sort
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html><head><title>[interchange-core] [sort] tag</title>
   
   <link rel="Index" href="index.html">
   <link rel="made" href="mailto:interchange-core%40interchange.redhat.com">
   <meta name="robots" content="index,nofollow">
   
   <link rel="Previous" href="000256.html">
   <link rel="Next" href="000257.html"><base href="http://www.icdevgroup.org/mailman/private/interchange-core/2001-October/000259.html"></head>

 <body bgcolor="#ffffff">
   <h1>[interchange-core] [sort] tag
   </h1>
    <b>Ed LaFrance
    </b> 
    <a href="mailto:interchange-core%40interchange.redhat.com" title="[interchange-core] [sort] tag">interchange-core at interchange.redhat.com
       </a><br>
    <i>Tue Oct 30 12:47:00 2001</i>
    <p></p><ul>
        <li> Previous message: <a href="000256.html">[interchange-core] [sort] tag
</a></li>
        <li> Next message: <a href="000257.html">[interchange-core] ProgrammingStandards
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#259">[ date ]</a>
              <a href="thread.html#259">[ thread ]</a>
              <a href="subject.html#259">[ subject ]</a>
              <a href="author.html#259">[ author ]</a>
         </li>
       </ul>
    <hr>  
<!--beginarticle-->
<pre>At 01:24 PM 10/30/2001 +0100, you wrote:
&gt;<i>Mike Heins &lt;<a href="mailto:mheins at redhat.com">mheins at redhat.com</a>&gt; writes:
</i>&gt;<i>
</i>&gt;<i> &gt; Quoting Stefan Hornburg (Racke) (<a href="mailto:racke at linuxia.de">racke at linuxia.de</a>):
</i>&gt;<i> &gt; &gt;
</i>&gt;<i> &gt; &gt; Is there any reason that this is tag is widely mentioned in the docs ?
</i>&gt;<i> &gt; &gt; I thought it is deprecated and can be replaced by other means.
</i>&gt;<i> &gt;
</i>&gt;<i> &gt; Because I did a good job of documenting that one and it was never
</i>&gt;<i> &gt; undocumented.
</i>&gt;<i>
</i>&gt;<i>Fine, but we can it take out now or not ?
</i>&gt;<i>
</i>&gt;<i>Ciao
</i>&gt;<i>         Racke
</i>
At this point I would not consider it useless, as I don't see any other way 
of sorting lists that don't come from search results, besides in-page perl 
code.  In particular, the sorting of [item-lists] comes to mind. In any 
case, [sort] is the only general-purpose sorting mechanism in ITL that I 
know of (please correct me if I am wrong here), and for that reason alone I 
think it is worth preserving.  Perhaps we can adjust the docs to 
de-emphasize the use of [sort] for searches in favor of tf/to and just keep 
the examples for [item-list] and [loop].

- Ed L.


</pre>
<!--endarticle-->
    <hr>
    <p></p><ul>
        <!--threads-->
	<li> Previous message: <a href="000256.html">[interchange-core] [sort] tag
</a></li>
	<li> Next message: <a href="000257.html">[interchange-core] ProgrammingStandards
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#259">[ date ]</a>
              <a href="thread.html#259">[ thread ]</a>
              <a href="subject.html#259">[ subject ]</a>
              <a href="author.html#259">[ author ]</a>
         </li>
       </ul>
</body></html>


1.1                  xmldocs/pending/newdevel


rev 1.1, prev_rev 1.0
Index: newdevel
===================================================================

- how do things work in icdevgroup :)
- mailing lists (mailman directory)
- everything that's in CVS (cvsweb directory), since "co ." doesn't work

- docset
- 



1.1                  xmldocs/pending/not-complicated.heh


rev 1.1, prev_rev 1.0
Index: not-complicated.heh
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html><head><title>[interchange-core] Looking for a task</title>
   
   <link rel="Index" href="index.html">
   <link rel="made" href="mailto:interchange-core%40interchange.redhat.com">
   <meta name="robots" content="index,nofollow">
   
   <link rel="Previous" href="000201.html">
   <link rel="Next" href="000203.html"><base href="http://www.icdevgroup.org/mailman/private/interchange-core/2001-October/000202.html"></head>

 <body bgcolor="#ffffff">
   <h1>[interchange-core] Looking for a task
   </h1>
    <b>Stefan Hornburg Racke

    </b> 
    <a href="mailto:interchange-core%40interchange.redhat.com" title="[interchange-core] Looking for a task">interchange-core at interchange.redhat.com
       </a><br>
    <i>Wed Oct 10 14:25:01 2001</i>
    <p></p><ul>
        <li> Previous message: <a href="000201.html">[interchange-core] Looking for a task
</a></li>
        <li> Next message: <a href="000203.html">[interchange-core] Looking for a task
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#202">[ date ]</a>
              <a href="thread.html#202">[ thread ]</a>
              <a href="subject.html#202">[ subject ]</a>
              <a href="author.html#202">[ author ]</a>
         </li>
       </ul>
    <hr>  
<!--beginarticle-->
<pre>Ed LaFrance &lt;<a href="mailto:edl at newmediaems.com">edl at newmediaems.com</a>&gt; writes:

&gt;<i> Hello core dwellers -
</i>&gt;<i> 
</i>&gt;<i> Being the new kid on the block, I wondering if someone has a project they 
</i>&gt;<i> would like to delegate to me - preferably not too complicated to start?
</i>
Uuh, not complicated. That's complicated with Interchange :-)
Of which parts of Interchange you have a deeper knowledge ?

Ciao
        Racke

-- 
Racke happily hacks Interchange and maintains Debian packages like Courier.

For projects and other business stuff please refer to COBOLT NetServices
(URL: <a href="http://www.cobolt.net;">http://www.cobolt.net;</a> Email: <a href="mailto:info at cobolt.net">info at cobolt.net</a>; Phone: 0041-1-3884400)

</pre>
<!--endarticle-->
    <hr>
    <p></p><ul>
        <!--threads-->
	<li> Previous message: <a href="000201.html">[interchange-core] Looking for a task
</a></li>
	<li> Next message: <a href="000203.html">[interchange-core] Looking for a task
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#202">[ date ]</a>
              <a href="thread.html#202">[ thread ]</a>
              <a href="subject.html#202">[ subject ]</a>
              <a href="author.html#202">[ author ]</a>
         </li>
       </ul>
</body></html>


1.1                  xmldocs/pending/perl-calc.diff.txt


rev 1.1, prev_rev 1.0
Index: perl-calc.diff.txt
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html><head><title>[interchange-core] Performance question: calc/perl</title>
   
   <link rel="Index" href="index.html">
   <link rel="made" href="mailto:interchange-core%40interchange.redhat.com">
   <meta name="robots" content="index,nofollow">
   
   <link rel="Previous" href="000183.html">
   <link rel="Next" href="000174.html"><base href="http://www.icdevgroup.org/mailman/private/interchange-core/2001-October/000185.html"></head>

 <body bgcolor="#ffffff">
   <h1>[interchange-core] Performance question: calc/perl
   </h1>
    <b>Mike Heins
    </b> 
    <a href="mailto:interchange-core%40interchange.redhat.com" title="[interchange-core] Performance question: calc/perl">interchange-core at interchange.redhat.com
       </a><br>
    <i>Mon Oct  8 11:22:00 2001</i>
    <p></p><ul>
        <li> Previous message: <a href="000183.html">[interchange-core] Performance question: calc/perl
</a></li>
        <li> Next message: <a href="000174.html">[interchange-core] Server is not running
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#185">[ date ]</a>
              <a href="thread.html#185">[ thread ]</a>
              <a href="subject.html#185">[ subject ]</a>
              <a href="author.html#185">[ author ]</a>
         </li>
       </ul>
    <hr>  
<!--beginarticle-->
<pre>Quoting Stefan Hornburg (Racke) (<a href="mailto:racke at linuxia.de">racke at linuxia.de</a>):
&gt;<i> Mike Heins &lt;<a href="mailto:mheins at redhat.com">mheins at redhat.com</a>&gt; writes:
</i>&gt;<i> 
</i>&gt;<i> &gt; Quoting Stefan Hornburg (Racke) (<a href="mailto:racke at linuxia.de">racke at linuxia.de</a>):
</i>&gt;<i> &gt; &gt; 
</i>&gt;<i> &gt; &gt; What can be said on the performance on the calc and perl tags.
</i>&gt;<i> &gt; &gt; They appear pretty similar. What are the differences ?
</i>&gt;<i> &gt; 
</i>&gt;<i> &gt; Calc is lower-overhead because it doesn't pre-open database tables
</i>&gt;<i> &gt; or do any extra wrapping of stuff.
</i>&gt;<i> 
</i>&gt;<i> Ah, thanks very much. Do you know if this is mentioned in the
</i>&gt;<i> documentation ?
</i>
Yes, right where you would expect:

    <a href="http://interchange.redhat.com/cgi-bin/ic/docfly.html?mv_arg=ictags04%2e08">http://interchange.redhat.com/cgi-bin/ic/docfly.html?mv_arg=ictags04%2e08</a>

-- 
Red Hat, Inc., 3005 Nichols Rd., Hamilton, OH  45013
phone +1.513.523.7621      &lt;<a href="mailto:mheins at redhat.com">mheins at redhat.com</a>&gt;

Fast, reliable, cheap.  Pick two and we'll talk.  -- unknown

</pre>
<!--endarticle-->
    <hr>
    <p></p><ul>
        <!--threads-->
	<li> Previous message: <a href="000183.html">[interchange-core] Performance question: calc/perl
</a></li>
	<li> Next message: <a href="000174.html">[interchange-core] Server is not running
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#185">[ date ]</a>
              <a href="thread.html#185">[ thread ]</a>
              <a href="subject.html#185">[ subject ]</a>
              <a href="author.html#185">[ author ]</a>
         </li>
       </ul>
</body></html>


1.1                  xmldocs/pending/programming-style


rev 1.1, prev_rev 1.0
Index: programming-style
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html><head><title>[interchange-core] ProgrammingStandards</title>
   
   <link rel="Index" href="index.html">
   <link rel="made" href="mailto:interchange-core%40interchange.redhat.com">
   <meta name="robots" content="index,nofollow">
   
   <link rel="Previous" href="000259.html">
   <link rel="Next" href="000258.html"><base href="http://www.icdevgroup.org/mailman/private/interchange-core/2001-October/000257.html"></head>

 <body bgcolor="#ffffff">
   <h1>[interchange-core] ProgrammingStandards
   </h1>
    <b>Jon Jensen
    </b> 
    <a href="mailto:interchange-core%40interchange.redhat.com" title="[interchange-core] ProgrammingStandards">interchange-core at interchange.redhat.com
       </a><br>
    <i>Tue Oct 30 10:08:00 2001</i>
    <p></p><ul>
        <li> Previous message: <a href="000259.html">[interchange-core] [sort] tag
</a></li>
        <li> Next message: <a href="000258.html">[interchange-core] ProgrammingStandards
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#257">[ date ]</a>
              <a href="thread.html#257">[ thread ]</a>
              <a href="subject.html#257">[ subject ]</a>
              <a href="author.html#257">[ author ]</a>
         </li>
       </ul>
    <hr>  
<!--beginarticle-->
<pre>The last "authoritative" statement on code standards was done about a year
ago, and is still on the Akopia Wiki. Basically perlstyle was formally
adopted and a few trivial additions made.

I like the way cuddled elses visually unify the whole control flow. But
even an else-cuddling diehard like me can change, if that's what people
want. :)

Jon


Programming Standards

(MikeHeins, JeffBarr, EricZarko, SonnyCook)

The following notes document a meeting that took place on November 14,
2000.

Introduction - We agreed that it is good to have a programming style, and
that the existing style of code should be preserved. We agreed that making
global changes to impose a consistent style is not worth doing. Instead,
we will make revisions as we rewrite code. We will generally follow the
published Perl style guidelines, and we will use 4 character tabs.

Else - We accept but do not encourage the use of the "cuddled else"
construct ("} else {" on a single line).

Lexical Issues - White space is free, and white space around operators
increases readability. Lining up the "=" in a series of assignments can be
used to emphasize the parallel structure.

Naming - Package globals should start with a capital letter. In other
situations, avoid StudlyCaps where names begin with a capital letter.
Items in the main package should be referenced as "$::Foo", not
"$main::Foo".

Globals - Global variables and subs should be used very sparingly.
Occasionally it is necessary to use global variables as implicit arguments
to certain subs for efficiency purposes. We should not add more globals,
and we should consider removing existing ones. An important exception are
certain subs such as logGlobal, logDebug, errmsg, and logError.

CVS - CVS comments should be meaningful. As a matter of good programming
practice, we encourage a careful review of all diffs before committing
changes to CVS. When committinga large number of files (possibly
containing changes and fixes to multiple areas) it is best to create
file-specific comments addressing individual fixes. Using a blanket
comment is not encouraged.

Loops - We prefer to declare loop control variables immediately prior to
the beginning of the loop:

my $var;
foreach $var () {
...
}

Bugzilla - We encourage the use of Bugzilla as a work queuing tool.
Entering and tracking all bugs, even those you find and then fix yourself,
is a good practice. Creating a relationship between a CVS commit and a
Bugzilla entry by listing the bug number in the CVS log message and the
file names in the Bugzilla entry is encouraged.


</pre>
<!--endarticle-->
    <hr>
    <p></p><ul>
        <!--threads-->
	<li> Previous message: <a href="000259.html">[interchange-core] [sort] tag
</a></li>
	<li> Next message: <a href="000258.html">[interchange-core] ProgrammingStandards
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#257">[ date ]</a>
              <a href="thread.html#257">[ thread ]</a>
              <a href="subject.html#257">[ subject ]</a>
              <a href="author.html#257">[ author ]</a>
         </li>
       </ul>
</body></html>


1.1                  xmldocs/pending/properrun


rev 1.1, prev_rev 1.0
Index: properrun
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html><head><title>[interchange-core] Checking Interchange page servers</title>
   
   <link rel="Index" href="index.html">
   <link rel="made" href="mailto:interchange-core%40interchange.redhat.com">
   <meta name="robots" content="index,nofollow">
   
   <link rel="Previous" href="000161.html">
   <link rel="Next" href="000164.html"><base href="http://www.icdevgroup.org/mailman/private/interchange-core/2001-October/000162.html"></head>

 <body bgcolor="#ffffff">
   <h1>[interchange-core] Checking Interchange page servers
   </h1>
    <b>Stefan Hornburg Racke

    </b> 
    <a href="mailto:interchange-core%40interchange.redhat.com" title="[interchange-core] Checking Interchange page servers">interchange-core at interchange.redhat.com
       </a><br>
    <i>Thu Oct  4 08:34:01 2001</i>
    <p></p><ul>
        <li> Previous message: <a href="000161.html">[interchange-core] Checking Interchange page servers
</a></li>
        <li> Next message: <a href="000164.html">[interchange-core] Freakish code appearance in makecat.PL
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#162">[ date ]</a>
              <a href="thread.html#162">[ thread ]</a>
              <a href="subject.html#162">[ subject ]</a>
              <a href="author.html#162">[ author ]</a>
         </li>
       </ul>
    <hr>  
<!--beginarticle-->
<pre><a href="mailto:mheins at redhat.com">mheins at redhat.com</a> writes:

&gt;<i> Quoting Stefan Hornburg (Racke) (<a href="mailto:racke at linuxia.de">racke at linuxia.de</a>):
</i>&gt;<i> &gt; 
</i>&gt;<i> &gt; How can I check if an Interchange page server is running properly or
</i>&gt;<i> &gt; is stuck in a loop ?
</i>&gt;<i> 
</i>&gt;<i> Kill it, even with a 0. If it responds, it is alive.
</i>
Ah, OK. That's a cute idea.

Ciao
        Racke

-- 
Racke happily hacks Interchange and maintains Debian packages like Courier.

For projects and other business stuff please refer to COBOLT NetServices
(URL: <a href="http://www.cobolt.net;">http://www.cobolt.net;</a> Email: <a href="mailto:info at cobolt.net">info at cobolt.net</a>; Phone: 0041-1-3884400)

</pre>
<!--endarticle-->
    <hr>
    <p></p><ul>
        <!--threads-->
	<li> Previous message: <a href="000161.html">[interchange-core] Checking Interchange page servers
</a></li>
	<li> Next message: <a href="000164.html">[interchange-core] Freakish code appearance in makecat.PL
</a></li>
         <li> <b>Messages sorted by:</b> 
              <a href="date.html#162">[ date ]</a>
              <a href="thread.html#162">[ thread ]</a>
              <a href="subject.html#162">[ subject ]</a>
              <a href="author.html#162">[ author ]</a>
         </li>
       </ul>
</body></html>


1.1                  xmldocs/pending/release-notes.txt


rev 1.1, prev_rev 1.0
Index: release-notes.txt
===================================================================
RELEASING A NEW VERSION OF INTERCHANGE
$Id: release-notes.txt,v 1.1 2004/11/03 19:08:24 docelic Exp $


Pre-release:

Check WHATSNEW against CVS logs, add release date
Update copyright dates as appropriate if new year since last release
Make sure version numbers are correct in all files:
	README
	README.rpm-dist
	configure
	Makefile.PL
	scripts/interchange.PL
	dist/foundation/products/mv_metadata.asc (ui-version)
	SPECS/interchange.spec
Double-check MANIFEST (create using LC_ALL=C)
Do a clean checkout from CVS to make sure no sticky tags exist in local checkout
Tag or re-tag CVS repository with REL_4_6_3 (or whatever)
Run regression test catalog
Build tarball and note MD5 sum
Build RPMs
Test clean install of Foundation demo, place order, use admin
Build docs tarball & RPMs (for stable releases)
Sign RPMs with personal GnuPG key
Have Racke build and sign Debian packages (using same tarball so MD5 sum is identical)
Have people test the packages
Make md5sums to mention in release notes, and in files on FTP server


Upload tarball, RPMs, README, WHATSNEW to:

root at ftp.icdevgroup.org:/var/ftp/pub/interchange...
Update interchange-latest.tar.gz symlinks for stable releases
Rename README to README.txt so Apache will display it
Rename README.rpm-dist to README.txt in rpm directory
Update WHATSNEW file to latest (no need to keep old ones in same branch, as their contents are still included in the latest file)


Update developer website:

http://www.icdevgroup.org/i/dev/index.html
http://www.icdevgroup.org/i/dev/download.html


Make announcements at:

interchange-users at icdevgroup.org
interchange-announce at icdevgroup.org
Freshmeat.net


Update demo stores, one editable, one static:

http://demo.icdevgroup.org/


Post-release:

Fork off stable branch if second version component is even, e.g. 4.8.0:
tag STABLE_4_8-root, branch STABLE_4_8-branch.








More information about the docs mailing list