[Zope3-checkins] CVS: Zope3/doc/zsync - links.rst:1.1 README.txt:1.7 zbundle.txt:1.3 zsync.txt:1.5

Fred L. Drake, Jr. fred at zope.com
Thu Aug 28 19:56:59 EDT 2003


Update of /cvs-repository/Zope3/doc/zsync
In directory cvs.zope.org:/tmp/cvs-serv29300

Modified Files:
	README.txt zbundle.txt zsync.txt 
Added Files:
	links.rst 
Log Message:
- move a lot of common link definitions to an include file
- minor changes for consistency


=== Added File Zope3/doc/zsync/links.rst ===
.. Common links used in the zsync docs.
   This file should have no comment, and should be included by each of
   the ReST documentation files in doc/zsync/.

.. |FSSYNC| replace::   *Filesystem Synchronization Proposal*
.. |TTWSITE| replace::  *Through the Web Site Development*
.. |zbundle| replace::  **zbundle**
.. |zsync| replace::    **zsync**

.. _FSSYNC:   http://dev.zope.org/Zope3/FileSystemSynchronizationProposal
.. _TTWSITE:  http://dev.zope.org/Zope3/ThroughTheWebSiteDevelopment
.. _zbundle:  zbundle.html
.. _zsync:    zsync.html

.. _Zope Corporation:     http://www.zope.com/
.. _Zope Public License:  http://www.zope.org/Resources/ZPL
.. _Zope 3 wiki:          http://dev.zope.org/Zope3/
.. _Zope 3 Development Issue Collector: http://collector.zope.org/Zope3-dev


=== Zope3/doc/zsync/README.txt 1.6 => 1.7 ===
--- Zope3/doc/zsync/README.txt:1.6	Wed Aug 27 17:07:47 2003
+++ Zope3/doc/zsync/README.txt	Thu Aug 28 18:56:58 2003
@@ -2,16 +2,14 @@
 Filesystem Synchronization
 ==========================
 
+
+Background
+----------
+
 For background and the original description by Jim Fulton, see the
 |FSSYNC|_.  Additional background material can be found in the
 |TTWSITE|_ proposal.
 
-.. |FSSYNC| replace::   Filesystem Synchronization Proposal
-.. |TTWSITE| replace::  Through the Web Site Development
-
-.. _FSSYNC:   http://dev.zope.org/Zope3/FileSystemSynchronizationProposal
-.. _TTWSITE:  http://dev.zope.org/Zope3/ThroughTheWebSiteDevelopment
-
 The "bundles" mentioned there are likely candidates for filesystem
 synchronization.  (See section `Working With Bundles`_ below.)
 
@@ -333,3 +331,5 @@
   list.  Deleting an active bundle usually doesn't work because of the
   dependencies between the configuration records and the configured
   objects in the bundle.
+
+.. include:: links.rst


=== Zope3/doc/zsync/zbundle.txt 1.2 => 1.3 ===
--- Zope3/doc/zsync/zbundle.txt:1.2	Thu Aug 28 14:09:43 2003
+++ Zope3/doc/zsync/zbundle.txt	Thu Aug 28 18:56:58 2003
@@ -1,3 +1,8 @@
+======================================
+zbundle -- Zope bundle management tool
+======================================
+
+
 Name
 ----
 
@@ -49,12 +54,12 @@
 Options
 +++++++
 
--f FACTORY, --factory FACTORY
+-f factory, --factory factory
   Specify the object factory to use for the object being added.
 
--t TYPE, --type TYPE           
-  The type of the object to be created.  Normally only *FACTORY* needs
-  to be specified.
+-t type, --type type           
+  The type of the object to be created.  Normally only *factory* needs
+  to be specified, if the default isn't sufficient.
 
 
 The **zbundle help** Command
@@ -93,12 +98,10 @@
 --------------
 
 Bugs in **zbundle** and the filesystem synchronization support in Zope 3
-should be reported via the `Zope 3 Development Issue Collector`__, an
+should be reported via the `Zope 3 Development Issue Collector`_, an
 online reporting tool that allows you to enter reports directly into
 our bug-tracking system.
 
-.. __: http://collector.zope.org/Zope3-dev
-
 
 See Also
 --------
@@ -107,9 +110,7 @@
 |zsync|_.
 
 There are two interesting and directly relevant articles in the `Zope 3
-wiki`__:
-
-.. __: http://dev.zope.org/Zope3/
+wiki`_:
 
 * The |FSSYNC|_ is the initial proposal for a way to synchronize
   copies of a Zope-based website between a filesystem-based
@@ -118,23 +119,13 @@
 * Bundles are discussed in |TTWSITE|_; this gives more information on
   the motivation and goals surrounding this work.
 
-.. |FSSYNC| replace::   Filesystem Synchronization Proposal
-.. |TTWSITE| replace::  Through the Web Site Development
-.. |zsync| replace::    **zsync**
-
-.. _FSSYNC:   http://dev.zope.org/Zope3/FileSystemSynchronizationProposal
-.. _TTWSITE:  http://dev.zope.org/Zope3/ThroughTheWebSiteDevelopment
-.. _zsync:    zsync.html
-
 
 Copyright
 ---------
 
-Copyright (c) 2003 `Zope Corporation`__ and Contributors.
+Copyright (c) 2003 `Zope Corporation`_ and Contributors.
 All Rights Reserved.
 
-.. __:  http://www.zope.com/
-
 This software is subject to the provisions of the `Zope Public
 License`_, Version 2.0 (ZPL).  A copy of the ZPL should accompany
 this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
@@ -142,4 +133,4 @@
 LIMITED TO, THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST
 INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 
-.. _Zope Public License:  http://www.zope.org/Resources/ZPL
+.. include:: links.rst


=== Zope3/doc/zsync/zsync.txt 1.4 => 1.5 ===
--- Zope3/doc/zsync/zsync.txt:1.4	Thu Aug 28 14:08:17 2003
+++ Zope3/doc/zsync/zsync.txt	Thu Aug 28 18:56:58 2003
@@ -1,3 +1,8 @@
+=============================================
+zsync -- Zope filesystem synchronization tool
+=============================================
+
+
 Name
 ----
 
@@ -100,11 +105,11 @@
 Options
 +++++++
 
--f FACTORY, --factory FACTORY
+-f factory, --factory factory
   Specify the object factory to use for the object being added.
 
--t TYPE, --type TYPE           
-  The type of the object to be created.  Normally only *FACTORY* needs
+-t type, --type type           
+  The type of the object to be created.  Normally only *factory* needs
   to be specified.
 
 
@@ -137,12 +142,12 @@
 Options
 +++++++
 
--F FILE, --file FILE
+-F file, --file file
   Set the message used for the transaction note to the contents of the
-  file *FILE* (similar to the ``-F`` option for **cvs commit**).
+  file *file* (similar to the ``-F`` option for **cvs commit**).
 
--m MSG, --message MSG
-  Set the message used for the transaction note to *MSG* (similar to
+-m msg, --message msg
+  Set the message used for the transaction note to *msg* (similar to
   the ``-m`` option for **cvs commit**).
 
 
@@ -190,11 +195,11 @@
 Options
 +++++++
 
--F FILE, --file FILE
+-F file, --file file
   Set the message used for the transaction note to the contents of the
-  file *FILE* (similar to the ``-F`` option for **cvs commit**).
+  file *file* (similar to the ``-F`` option for **cvs commit**).
 
--m MSG, --message MSG
+-m msg, --message msg
   Set the message used for the transaction note (similar to the ``-m``
   option for **cvs commit**).
 
@@ -247,9 +252,9 @@
 -c
   Generate a context diff.
 
--C NUM, --context NUM
+-C num, --context num
   Set the number of lines of context information included on each side
-  of changes to *NUM*.
+  of changes to *num*.
 
 -i
   Ignore changes in case; consider upper- andlower-case letters
@@ -263,9 +268,9 @@
 -u
   Generate a unified diff.
 
--U NUM, --unified NUM
-  Use the unified output format, showing *NUM* (an integer) lines of
-  context, or three if *NUM* is not given.  For proper operation,
+-U num, --unified num
+  Use the unified output format, showing *num* (an integer) lines of
+  context, or three if *num* is not given.  For proper operation,
   **patch** typically needs at least two lines of context.
 
 
@@ -317,7 +322,7 @@
 Options
 +++++++
 
--u USER, --user USER
+-u user, --user user
   Use *USER* for the username.  This overrides the username given via
   the URL; this is mostly intended for people who don't know (or don't
   want to admit knowing!) the obscure URL syntax for encoding the
@@ -350,8 +355,8 @@
 Options
 +++++++
 
--u USER, --user USER
-  Use *USER* for the username.  This overrides the username given via
+-u user, --user user
+  Use *user* for the username.  This overrides the username given via
   the URL; this is mostly intended for people who don't know (or don't
   want to admit knowing!) the obscure URL syntax for encoding the
   username for a site.
@@ -531,20 +536,16 @@
 --------------
 
 Bugs in **zsync** and the filesystem synchronization support in Zope 3
-should be reported via the `Zope 3 Development Issue Collector`__, an
+should be reported via the `Zope 3 Development Issue Collector`_, an
 online reporting tool that allows you to enter reports directly into
 our bug-tracking system.
 
-.. __: http://collector.zope.org/Zope3-dev
-
 
 See Also
 --------
 
 There are two interesting and directly relevant articles in the `Zope 3
-wiki`__:
-
-.. __: http://dev.zope.org/Zope3/
+wiki`_:
 
 * The |FSSYNC|_ is the initial proposal for a way to synchronize
   copies of a Zope-based website between a filesystem-based
@@ -556,23 +557,13 @@
 The |zbundle|_ documentation provides support for managing bundles
 using a **zsync** checkout.
 
-.. |FSSYNC| replace::   Filesystem Synchronization Proposal
-.. |TTWSITE| replace::  Through the Web Site Development
-.. |zbundle| replace::  **zbundle**
-
-.. _FSSYNC:   http://dev.zope.org/Zope3/FileSystemSynchronizationProposal
-.. _TTWSITE:  http://dev.zope.org/Zope3/ThroughTheWebSiteDevelopment
-.. _zbundle: zbundle.html
-
 
 Copyright
 ---------
 
-Copyright (c) 2003 `Zope Corporation`__ and Contributors.
+Copyright (c) 2003 `Zope Corporation`_ and Contributors.
 All Rights Reserved.
 
-.. __:  http://www.zope.com/
-
 This software is subject to the provisions of the `Zope Public
 License`_, Version 2.0 (ZPL).  A copy of the ZPL should accompany
 this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
@@ -580,4 +571,4 @@
 LIMITED TO, THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST
 INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 
-.. _Zope Public License:  http://www.zope.org/Resources/ZPL
+.. include:: links.rst




More information about the Zope3-Checkins mailing list