Skip to content

Commit

Permalink
Convert many mentions of CVS to Git
Browse files Browse the repository at this point in the history
  • Loading branch information
jonjensen committed Jan 4, 2010
1 parent 9307a23 commit 54dfa0a
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 35 deletions.
2 changes: 1 addition & 1 deletion Makefile
@@ -1,7 +1,7 @@
#
# ICDEVGROUP Documentation Makefile
# http://www.icdevgroup.org
# http://www.icdevgroup.org/cgi-bin/cvsweb/xmldocs
# http://git.icdevgroup.org/?p=xmldocs.git;a=summary
#
# Davor Ocelic, docelic@icdevgroup.org
#
Expand Down
14 changes: 7 additions & 7 deletions README
Expand Up @@ -48,7 +48,7 @@ targets would include:
make clean (removes OUTPUT/)
make distclean (remove OUTPUT/ and tmp/)
make look-clean (clean + 'mv tmp tmp.temporary'. Useful to only make
the tree as if it is clean (to perform CVS operations
the tree as if it is clean (to perform Git operations
without errors), but then automatically rename
the directory back to 'tmp/' and avoid the overhead of
regenerating OlinkDB files).
Expand Down Expand Up @@ -132,7 +132,7 @@ During the invocation of 'make', few files will be created:
cache/<ver>/.cache.bin is generated by bin/stattree.

The cache is Perl's portable Storable dump. It was
originally kept in the CVS (so others could re-use it),
originally kept in Git (so others could re-use it),
but that didn't play out well in practice so now everyone
building the docs needs to have the sources/ directory
ready and run 'make caches' himself to get the .bin
Expand Down Expand Up @@ -173,14 +173,14 @@ DEVELOPMENT NOTES
the docset, but don't have the time to prepare it
yourself, just drop it in there and someone will pick
it up.
sources - (not in CVS). run 'make git' to auto-create this
sources - (Not in Git.) run 'make git' to auto-create this
directory with all needed contents.
whatsnew - A directory containing whatsnew.xml, continuously updated
what's new list. The items are added automatically; just
place copies of the CVS commit messages in the whatsnew/
place copies of the Git commit messages in the whatsnew/
directory; every time you run bin/whatsnew-update, it will
process the files and update whatsnew.xml, which you can
then check-in (or update) in CVS.
then push in Git.


Updating cache/:
Expand Down Expand Up @@ -251,7 +251,7 @@ DEVELOPMENT NOTES
and can effectively be used as a comment area.

The refs/<symbol> single-file-based approach is now preferred. It's more
convenient, and keeps the number of files in CVS at minimum. The bin/editem
convenient, and keeps the number of files in Git to a minimum. The bin/editem
script advises to use it.
Use refs/<symbol>/* only in special cases (which is never, or close to it).

Expand Down Expand Up @@ -317,7 +317,7 @@ DEVELOPMENT NOTES
** is to start off by copying an existing item over.

** When adding documentation entries, please favor QUALITY over QUANTITY.
** That means you should grep the whole CVS for ALL information about a
** That means you should grep the whole Git repo for ALL information about a
** symbol (and supplement that with your own invaluable historical and
** technical information), and then write the item documentation that
** includes all that information.
Expand Down
5 changes: 2 additions & 3 deletions TODO
Expand Up @@ -93,8 +93,7 @@ Ideas:
- new developer howto
- filenames in Source contexts should also be clickable. this is longterm
because it'll involve perltidy and other stuff I have in mind ...
- CVS page: http://www.icdevgroup.org/i/dev/cvs.html?id=auxbUMnz
Make a tutorial : IC from CVS, Catalog in SVN, replicated setup online
- Make a tutorial : IC from Git, Catalog in SVN, replicated setup online
and locally
- How to deal with Safe
Programming guidelines doc - integrate with programming style. Advise
Expand Down Expand Up @@ -185,7 +184,7 @@ Community-contributed usertags (was usertag.pod before 4.7.0; too messy)
icstart - Getting Started Guide
* FAQ for each demo catalog (foundation, construct, barry, artstore)
* FAQ for each database (DBM, MySQL, PostgreSQL, Oracle)
* FAQ for each payment processor (CCVS, Cybercash, Signio, Authorize.net, etc.)
* FAQ for each payment processor (Payflow Pro, Authorize.net, etc.)



Expand Down
18 changes: 9 additions & 9 deletions WRITING
Expand Up @@ -3,7 +3,7 @@ The Interchange Development Group
http://www.icdevgroup.org

ICDEVGROUP Documentation Set
http://www.icdevgroup.org/cgi-bin/cvsweb/xmldocs/
http://git.icdevgroup.org/?p=xmldocs.git;a=summary

Documentation writing/authoring QuickStart.

Expand Down Expand Up @@ -38,11 +38,11 @@ invoked[1], the XML source files must already be put together and wait ready
to be processed.

As we've said that our goal is to autogenerate as much XML as possible, it's
obvious that we do not keep the XML sources in the CVS. (That would be pretty
obvious that we do not keep the XML sources in Git. (That would be pretty
inflexible, make larger changes very inconvenient, and require daily fixes and
updates to the CVS).
updates to the Git repo.)

Instead of the above, what we keep in the CVS are a number of documentation
Instead of the above, what we keep in Git are a number of documentation
snippets (only those parts that need to be written manually). We first rely on
the bin/stattree script to extract information from Interchange sources[2],
then on bin/*-autogen scripts to combine templates, mentioned stattree
Expand All @@ -54,7 +54,7 @@ The system separates documentation contents into 5 major groups:
1 guides: prose-based documents that explain concepts and are intended to
. be read from top to bottom.
. Autogeneration of contents is obviously of little use here, so we directly
. keep .xml sources in the CVS.
. keep .xml sources in Git.
. At (many) places where the external contents need to be included, we use
xi:include, native DocBook feature.

Expand All @@ -68,19 +68,19 @@ The system separates documentation contents into 5 major groups:
. all types of symbols. (Symbols are "units" seen in Interchange source -
. tags, filters, pragmas, global/catalog variables, Perl functions, ...).
. Enormous ammount of autogeneration and templating is possible here, and
. we keep snippets in CVS (format is, again, XML with all kinds of headers
. we keep snippets in Git (format is, again, XML with all kinds of headers
and containers already included in templates so you can just focus on text).

4 glossary: prose-based collection of glossary items.
. Some templating is possible here, so we keep individual glossary snippets
. (in XML format, minus standard headings which are included in the templates)
. in the CVS, while they are put together in a single glossary.xml file by the
. in Git, while they are put together in a single glossary.xml file by the
bin/generic-autogen script.

5 whatsnew file: there's a bin/whatsnew-update script that takes care of
. automatic whatsnew file updates.
. The .xml file is directly kept in the CVS, while bin/whatsnew-update knows
. how to update it; you only need to check-in the updated whatsnew file to CVS.
. The .xml file is directly kept in Git, while bin/whatsnew-update knows
. how to update it; you only need to check-in the updated whatsnew file to Git.
. More information on this can be found in bin/whatsnew-update and
whatsnew/whatsnew.xml.

Expand Down
2 changes: 1 addition & 1 deletion bin/pp
Expand Up @@ -31,7 +31,7 @@ my %tt = (
# Mimic docbook entities
my %entities = (
IC =>'<ulink url="http://www.icdevgroup.org">Interchange</ulink>',
ICCVS => '<ulink url="http://www.icdevgroup.org/i/dev/cvs.html">CVS</ulink>',
ICGIT => '<ulink url="http://www.icdevgroup.org/i/dev/download">Git</ulink>',
ICDL => '<ulink url="http://http://www.icdevgroup.org/i/dev/download.html">tarball</ulink>',
ICSTDCAT => 'interchange-cat-standard',
FS => '<ulink url="http://www.fsf.org">Free Software</ulink>',
Expand Down
8 changes: 4 additions & 4 deletions docbook/html-common.xsl
Expand Up @@ -78,19 +78,19 @@
</xsl:element> |
<xsl:element name="a">
<xsl:attribute name="href">
<xsl:value-of select="'http://www.icdevgroup.org/cgi-bin/cvsweb/interchange/'"/>
<xsl:value-of select="'http://git.icdevgroup.org/?p=interchange.git;a=summary'"/>
</xsl:attribute>
Interchange CVS
Interchange Git
</xsl:element>
(<xsl:element name="a">
<xsl:attribute name="href">
<xsl:value-of select="'http://www.icdevgroup.org/pipermail/interchange-cvs/'"/>
</xsl:attribute>Commits</xsl:element>) |
<xsl:element name="a">
<xsl:attribute name="href">
<xsl:value-of select="'http://www.icdevgroup.org/cgi-bin/cvsweb/xmldocs/'"/>
<xsl:value-of select="'http://git.icdevgroup.org/?p=xmldocs.git;a=summary'"/>
</xsl:attribute>
Documentation CVS
Documentation Git
</xsl:element>
(<xsl:element name="a">
<xsl:attribute name="href">
Expand Down
18 changes: 9 additions & 9 deletions docbook/literals.ent
Expand Up @@ -15,14 +15,14 @@
<!ENTITY r5.7.0 "4.6.0;4.8.0;5.0.0;5.2.0;5.5.0;5.5.2;5.6.0;5.7.0">

<!-- GENERAL ENTITIES -->
<!ENTITY GNU "<ulink url='http://www.gnu.org'>GNU</ulink>">
<!ENTITY IC "<ulink url='http://www.icdevgroup.org'>Interchange</ulink>">
<!ENTITY ICDEVGROUP "<ulink url='http://www.icdevgroup.org'>Interchange Development Group</ulink>">
<!ENTITY RH "<ulink url='http://www.redhat.com'>Red Hat</ulink>">
<!ENTITY DEB "<ulink url='http://www.debian.org'>Debian</ulink>">
<!ENTITY DEBGNU "<ulink url='http://www.debian.org'>Debian GNU</ulink>">
<!ENTITY GNU "<ulink url='http://www.gnu.org/'>GNU</ulink>">
<!ENTITY IC "<ulink url='http://www.icdevgroup.org/'>Interchange</ulink>">
<!ENTITY ICDEVGROUP "<ulink url='http://www.icdevgroup.org/'>Interchange Development Group</ulink>">
<!ENTITY RH "<ulink url='http://www.redhat.com/'>Red Hat</ulink>">
<!ENTITY DEB "<ulink url='http://www.debian.org/'>Debian</ulink>">
<!ENTITY DEBGNU "<ulink url='http://www.debian.org/'>Debian GNU</ulink>">
<!ENTITY ICDL "<ulink url='http://www.icdevgroup.org/i/dev/download.html'>download</ulink>">
<!ENTITY ICCVS "<ulink url='http://www.icdevgroup.org/cgi-bin/cvsweb/interchange/'>CVS</ulink>">
<!ENTITY ICGIT "<ulink url='http://git.icdevgroup.org/?p=interchange.git;a=summary'>Git</ulink>">
<!ENTITY PUBLIC_MLS "<ulink url='http://www.icdevgroup.org/mailman/listinfo/'>Public Interchange Mailing Lists</ulink>">
<!ENTITY APACHE "<ulink url='http://www.apache.org/'>Apache</ulink>">
<!ENTITY MATHOPD "<ulink url='http://www.mathopd.org/'>Mathopd</ulink>">
Expand All @@ -35,8 +35,8 @@
<!ENTITY PGSQL "<ulink url='http://www.postgresql.org/'>PostgreSQL</ulink>">
<!ENTITY ORACLE "<ulink url='http://www.oracle.com/'>Oracle</ulink>">
<!ENTITY OPENLDAP "<ulink url='http://www.openldap.org/'>OpenLDAP</ulink>">
<!ENTITY BDBM "<ulink url='http://http://www.sleepycat.com//'>Berkeley DBM</ulink>">
<!ENTITY GDBM "<ulink url='http://www.delorie.com/gnu/docs/gdbm/'>GNU DBM</ulink>">
<!ENTITY BDBM "<ulink url='http://www.oracle.com/database/berkeley-db/index.html'>Berkeley DB</ulink>">
<!ENTITY GDBM "<ulink url='http://www.vivtek.com/gdbm/'>GNU DBM</ulink>">
<!ENTITY SQLite "<ulink url='http://www.sqlite.org/'>SQLite</ulink>">
<!ENTITY NFS "<ulink url='http://nfs.sourceforge.net/'>NFS</ulink>">
<!ENTITY IMAGEMAGICK "<ulink url='http://www.imagemagick.org/'>ImageMagick</ulink>">
Expand Down
2 changes: 1 addition & 1 deletion whatsnew/WHATSNEW.xml
Expand Up @@ -35,7 +35,7 @@
This document serves as a convenient source of "What's new?"
&IC; information.
</para><para>
The entries found here are just excerpts from our &ICCVS; commit
The entries found here are just excerpts from our &ICGIT; commit
messages.
</para><para>
You could subscribe to the
Expand Down

0 comments on commit 54dfa0a

Please sign in to comment.