[Zope-CVS] CVS: Packages/zpkgtools/doc - Makefile:1.6 TODO.txt:1.11 index.txt:1.5

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/zpkgtools/doc
In directory cvs.zope.org:/tmp/cvs-serv32304

Modified Files:
	Makefile TODO.txt index.txt 
Log Message:
make the TO-DO list proper reStructuredText and link to it from the index


=== Packages/zpkgtools/doc/Makefile 1.5 => 1.6 ===
--- Packages/zpkgtools/doc/Makefile:1.5	Wed Apr 14 09:42:16 2004
+++ Packages/zpkgtools/doc/Makefile	Wed Apr 21 10:10:26 2004
@@ -23,6 +23,7 @@
 	index.html \
 	metadata.html \
 	resources.html \
+	TODO.html \
 	zpkg.html
 
 


=== Packages/zpkgtools/doc/TODO.txt 1.10 => 1.11 ===
--- Packages/zpkgtools/doc/TODO.txt:1.10	Wed Apr 21 10:03:08 2004
+++ Packages/zpkgtools/doc/TODO.txt	Wed Apr 21 10:10:26 2004
@@ -1,10 +1,14 @@
+===========================
+Things that need to be done
+===========================
+
 - Need name + acronym to describe what gets built, not normal words
   (Jim sez).
 
 - Need to add support for Subversion checkouts.
 
 - We should have some way to wildcard an entire hierarchy of packages
-  in resource maps.  Something like
+  in resource maps.  Something like::
 
     zope.*  cvs://cvs.zope.org/cvs-repository:Zope3/src/zope/
 
@@ -16,16 +20,17 @@
   priority.
 
 - There needs to be a better error message when two resources use the
-  same name part.  The problem is that package:foo and collection:foo
-  both have the same name, and zpkg tries to create two different
-  directories of the same name as children of the distribution root.
+  same name part.  The problem is that ``package:foo`` and
+  ``collection:foo`` both have the same name, and **zpkg** tries to
+  create two different directories of the same name as children of the
+  distribution root.
 
   Other ways to solve the problem:
 
   - Remove the resource type from the resource identifier, so names
     have to be unique to begin with.  Each resource will be expected
     to identify itself in some way (possibly implicitly, such as by
-    the presence of an __init__.py file).  This would mean we need an
+    the presence of an *__init__.py* file).  This would mean we need an
     explicit control of how we deal with dependencies (whether or not
     we include them in the distribution package, in particular); this
     would likely be a good thing, but doesn't depend on the change in
@@ -33,7 +38,7 @@
 
   - Change the structure of the distribution, so that collection and
     package resources are located in different directories; for
-    collection:foo and package:foo, we could end up with::
+    ``collection:foo`` and ``package:foo``, we could end up with::
 
       foo-x.y/
           collections/
@@ -44,7 +49,7 @@
 - Deal with a package tree like the zope package tree that includes
   both pure-Python and non-pure packages; these could easily land in
   separate directory hierarchies for installations using a different
-  $prefix and $exec_prefix.  (The pkgutil module from the standard
+  $prefix and $exec_prefix.  (The ``pkgutil`` module from the standard
   library does not provide an acceptable solution due to a bug: see
   http://www.python.org/sf/935117 for more info.)
 
@@ -56,7 +61,7 @@
 - CVS retriever (mostly done; need to deal with unspecified type and
   user for remote repositories)
 
-  - can check ~/.cvspass to see if there's an entry there
+  - can check *~/.cvspass* to see if there's an entry there
 
   - otherwise assume :ext: if there's a CVS_RSH setting?  or just
     always?  try anonymous :pserver: access?


=== Packages/zpkgtools/doc/index.txt 1.4 => 1.5 ===
--- Packages/zpkgtools/doc/index.txt:1.4	Mon Apr  5 12:17:54 2004
+++ Packages/zpkgtools/doc/index.txt	Wed Apr 21 10:10:26 2004
@@ -26,6 +26,10 @@
   package is entirely open to change at this point, but this might
   help to understand how to tool works.
 
+`To-do list <TODO.html>`_
+  List of things that still need to be handled, of course.
+
+
 Related Links
 -------------