SVN: zpkgtools/trunk/doc/ remove repository: URL scheme; it just was not useful after all
"Fred L. Drake, Jr." <[email protected]>
| Newsgroups | gmane.comp.web.zope.public-cvs |
|---|---|
| Message-ID | <[email protected]> |
Log message for revision 37876: remove repository: URL scheme; it just was not useful after all Changed: U zpkgtools/trunk/doc/resources.txt U zpkgtools/trunk/doc/zpkg.txt -=- Modified: zpkgtools/trunk/doc/resources.txt =================================================================== --- zpkgtools/trunk/doc/resources.txt 2005-08-11 18:24:50 UTC (rev 37875) +++ zpkgtools/trunk/doc/resources.txt 2005-08-11 20:26:33 UTC (rev 37876) @@ -15,12 +15,9 @@ but that's considered a quality-of-implementation issue that can be dealt with if needed.) -Two additional URL scheme have been defined specifically for use with -this tool. The ``cvs:`` scheme identifies a resource stored in a CVS -repository (either local or remote), and the ``repository:`` scheme -provides a way to spell a location relative to another in a CVS -repository. (It makes sense to 'join' a ``cvs:`` and a -``repository:`` URL to generate a new ``cvs:`` URL.) +A URL scheme has been defined specifically for use with this tool. +The ``cvs:`` scheme identifies a resource stored in a CVS repository +(either local or remote). Subversion is supported using the ``svn:``, ``svn+ssh:`` (as well as Subversion's general ``svn+special:`` schemes), and @@ -69,70 +66,6 @@ cvs://user@pw:cvs.example.org:pserver/cvsroot/module/doc/:r1-1-maint-branch -Relative Locations and the ``repository:`` Scheme -------------------------------------------------- - -The ``repository:`` scheme is used to identify a resource relative to -some other URL used with a revision control system. It contains the -following parts, separated by colons: - -- scheme identifier (always ``repository``) -- path -- tag - -The path can be relative or absolute, or omitted. If the path is -omitted, the join operation with a ``cvs:`` URL does not modify the -path of the resource that's identified. - -The tag part, including the colon used to separate it from the rest, -can be omitted. The tag can specify a symbolic tag, a branch tag, or -a revision number. - -Some examples:: - - repository:README.txt - - repository:src/mypackage/ - - repository:src/module.py:release-1-2 - - repository:/Zope3:ZopeX3-0_0-m3 - - -Joining ``cvs:`` and ``repository:`` URLs ------------------------------------------ - -Joining a ``cvs:`` and ``repository:`` URL results in a new ``cvs:`` -URL. The only portions of the URL which may differ from the original -``cvs:`` URL are the path and tag components; the ``repository:`` URL -cannot affect the repository which is referenced. - -If the ``repository:`` URL specifies an absolute path, that path is -used instead of the path from the original ``cvs:`` URL; otherwise the -two paths are joined in the same manner as path components for HTTP -URLs are joined. - -If the ``repository:`` URL specifies a tag, that is used, otherwise -the tag from the original ``cvs:`` URL is used. - -Some examples: - -========================= ========================== ==================================== -Base URL Relative URL Result -========================= ========================== ==================================== -cvs:///cvsroot:module:TAG repository:README.txt cvs:///cvsroot:module/README.txt:TAG -cvs:///cvsroot:module repository:/pkg/README.txt cvs:///cvsroot:pkg/README.txt -cvs:///cvsroot:module repository::tag cvs:///cvsroot:module:tag -cvs:///cvsroot:module:FOO repository:README.txt:BAR cvs:///cvsroot:module/README.txt:BAR -========================= ========================== ==================================== - - -Joining Subversion and ``repository:`` URLs -------------------------------------------- - -XXX To be written - - Supporting Other Revision Control Systems ----------------------------------------- @@ -140,5 +73,7 @@ a somewhat limited fashion. Support for additional systems hinges on creating new URL schemes for -each system, and an appropriate join operation if ``repository:`` URLs -need to be usable with them. +each system. + +Most of the time, it makes more sense to use file: URLs to reference +files in a checkout on the local system. Modified: zpkgtools/trunk/doc/zpkg.txt =================================================================== --- zpkgtools/trunk/doc/zpkg.txt 2005-08-11 18:24:50 UTC (rev 37875) +++ zpkgtools/trunk/doc/zpkg.txt 2005-08-11 20:26:33 UTC (rev 37876) @@ -168,9 +168,10 @@ ------------- A `resource map` is a mapping of resource names to URLs. The URLs -will most often be ``cvs:``, ``svn:``, or ``repository:`` URLs, but do -not have to be. See `Resource Locations <resources.html>`_ for more -information on using URLs for specific locations. +will most often be ``cvs:``, ``svn:``, or ``file:`` URLs, but do not +have to be. See `Resource Locations <resources.html>`_ for more +information on using URLs for specific locations. Relative URLs are +resolved relative to the file containing the reference. Resources are identified by names without any whitespace; if the resource is a Python package, the resource name is the full package @@ -192,12 +193,7 @@ allows all descendent packages of "foo" to be located. -Resource maps which have CVS locations of their own can contain -``repository:`` URLs; the ``cvs:`` or ``svn:`` URL of the directory -containing the map itself is used as the base for resolving -``repository:`` URLs. - Zope Corporation Tagging Convention ----------------------------------- _______________________________________________ Zope-CVS maillist - [email protected] http://mail.zope.org/mailman/listinfo/zope-cvs Zope CVS instructions: http://dev.zope.org/CVS