Rev 63: Make the doc more easily discoverable. in http://bazaar.launchpad.net/~bzr-upload-devs/bzr-upload/trunk
Vincent Ladeuil
v.ladeuil+lp at free.fr
Sat Sep 5 12:35:24 BST 2009
At http://bazaar.launchpad.net/~bzr-upload-devs/bzr-upload/trunk
------------------------------------------------------------
revno: 63
revision-id: v.ladeuil+lp at free.fr-20090905113521-901et7depwu6osh3
parent: v.ladeuil+lp at free.fr-20090902223106-u93g8rhrh3fexczr
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: trunk
timestamp: Sat 2009-09-05 13:35:21 +0200
message:
Make the doc more easily discoverable.
* __init__.py:
Populate the docstring with the README.
(cmd_upload): Add a pointer to the plugins/upload help topic.
* README:
Move most of the content in the module docstring.
-------------- next part --------------
=== modified file 'NEWS'
--- a/NEWS 2009-09-02 17:05:27 +0000
+++ b/NEWS 2009-09-05 11:35:21 +0000
@@ -21,6 +21,13 @@
* The auto hook verbosity is now controlled by the 'upload_auto_quiet'
config variable. If defaults to False if not set.
+ (Vincent Ladeuil, #312686)
+
+* The file where the revision id is stored on the remote server is now
+ controlled by the 'upload_revid_location' configuration variable. It
+ defaults to '.bzr-upload.revid'.
+ (Vincent Ladeuil, #423331)
+
Bug Fixes
*********
@@ -38,6 +45,10 @@
* Clarify 'changes' definition in online help.
(Vincent Ladeuil, #275538)
+* Move the README file into the module doc string so that it
+ becomes available through the 'bzr help plugins/upload'
+ command. (Vincent Ladeuil, #424193)
+
API Changes
***********
=== modified file 'README'
--- a/README 2009-09-02 22:31:06 +0000
+++ b/README 2009-09-05 11:35:21 +0000
@@ -19,105 +19,4 @@
Vincent Ladeuil <v.ladeuil+lp at free.fr>
Martin Albisetti <argentina at gmail.com>
-
-Quickstart
-----------
-
-To get started, it's as simple as running::
-
- bzr upload sftp://user@host/location/on/webserver
-
-This will initially upload the whole working tree, and leave a file on the
-remote location indicating the last revision that was uploaded
-(.bzr-upload.revid), in order to avoid uploading unnecessary information
-the next time.
-
-If you would like to upload a specific revision, you just do:
-
- bzr upload -r X sftp://user@host/location/on/webserver
-
-bzr-upload, just as bzr does, will remember the location where you upload the
-first time, so you don't need to specify it every time.
-
-If you need to re-upload the whole working tree for some reason, you can:
-
- bzr upload --full sftp://user@host/location/on/webserver
-
-
-If the layout of your remote server is such that you can't write in the
-root directory but only in the directories inside that root, you will need
-to use the 'upload_revid_location' configuration variable to specify the
-relative path to be used. That configuration variable can be specified in
-locations.conf or branch.conf.
-
-For example, given the following layout:
-
- Project/
- private/
- public/
-
-you may have write access in 'private' and 'public' but in 'Project'
-itself. In that case, you can add the following in your locations.conf or
-branch.conf file:
-
- upload_revid_location = private/.bzr-upload.revid
-
-
-Automatically Uploading
------------------------
-
-bzr-upload comes with a hook that can be used to trigger an upload whenever
-the tip of the branch changes, including on commit, push, uncommit etc. This
-would allow you to keep the code on the target up to date automatically.
-
-The easiest way to enable this is to run upload with the --auto option.
-
- bzr upload --auto
-
-will enable the hook for this branch. If you were to do a commit in this branch
-now you would see it trigger the upload automatically.
-
-If you wish to disable this for a branch again then you can use the --no-auto
-option.
-
- bzr upload --no-auto
-
-will disable the feature for that branch.
-
-Since the auto hook is triggered automatically, you can't use the --quiet
-option available for the upload command. Instead, you can set the
-'upload_auto_quiet' configuration variable to True or False in either
-bazaar.conf, locations.conf or branch.conf.
-
-
-Upload from Remote Location
----------------------------
-
-It is possible to upload to a remote location from another remote location by
-specifying it with the --directory option:
-
- bzr upload ftp://public.example.com --directory sftp://private.example.com
-
-This, together with --auto, can be used to upload when you push to your
-central branch, rather than when you commit to your local branch.
-
-Note that you will consume more bandwith this way than uploading from a local
-branch.
-
-Collaborating
--------------
-
-While we don't have any platform setup, you can branch from trunk:
-
- bzr branch lp:bzr-upload
-
-And change anything you'd like, and get in touch with any of the authors to
-review and add the changes.
-
-
-Known Issues
-------------
-
- * Symlinks are not supported
-
-
+Use bzr help plugins/upload to get more info.
=== modified file '__init__.py'
--- a/__init__.py 2009-09-02 22:31:06 +0000
+++ b/__init__.py 2009-09-05 11:35:21 +0000
@@ -16,16 +16,113 @@
"""Upload a working tree, incrementally.
+Quickstart
+----------
+
+To get started, it's as simple as running::
+
+ bzr upload sftp://user@host/location/on/webserver
+
+This will initially upload the whole working tree, and leave a file on the
+remote location indicating the last revision that was uploaded
+(.bzr-upload.revid), in order to avoid uploading unnecessary information the
+next time.
+
+If you would like to upload a specific revision, you just do:
+
+ bzr upload -r X sftp://user@host/location/on/webserver
+
+bzr-upload, just as bzr does, will remember the location where you upload the
+first time, so you don't need to specify it every time.
+
+If you need to re-upload the whole working tree for some reason, you can:
+
+ bzr upload --full sftp://user@host/location/on/webserver
+
+
+Automatically Uploading
+-----------------------
+
+bzr-upload comes with a hook that can be used to trigger an upload whenever
+the tip of the branch changes, including on commit, push, uncommit etc. This
+would allow you to keep the code on the target up to date automatically.
+
+The easiest way to enable this is to run upload with the --auto option.
+
+ bzr upload --auto
+
+will enable the hook for this branch. If you were to do a commit in this branch
+now you would see it trigger the upload automatically.
+
+If you wish to disable this for a branch again then you can use the --no-auto
+option.
+
+ bzr upload --no-auto
+
+will disable the feature for that branch.
+
+Since the auto hook is triggered automatically, you can't use the --quiet
+option available for the upload command. Instead, you can set the
+'upload_auto_quiet' configuration variable to True or False in either
+bazaar.conf, locations.conf or branch.conf.
+
+
+Storing the '.bzr-upload.revid' file
+------------------------------------
+
The only bzr-related info uploaded with the working tree is the corresponding
revision id. The uploaded working tree is not linked to any other bzr data.
-The intended use is for web developers which keep their web sites versioned
-with bzr, can can use either FTP or SFTP to upload their site.
-
-Known limitations:
-- Symlinks are ignored,
-
-- chmod bits (other than the owner's execution bit) are not supported.
+If the layout of your remote server is such that you can't write in the
+root directory but only in the directories inside that root, you will need
+to use the 'upload_revid_location' configuration variable to specify the
+relative path to be used. That configuration variable can be specified in
+locations.conf or branch.conf.
+
+For example, given the following layout:
+
+ Project/
+ private/
+ public/
+
+you may have write access in 'private' and 'public' but in 'Project'
+itself. In that case, you can add the following in your locations.conf or
+branch.conf file:
+
+ upload_revid_location = private/.bzr-upload.revid
+
+
+Upload from Remote Location
+---------------------------
+
+It is possible to upload to a remote location from another remote location by
+specifying it with the --directory option:
+
+ bzr upload ftp://public.example.com --directory sftp://private.example.com
+
+This, together with --auto, can be used to upload when you push to your
+central branch, rather than when you commit to your local branch.
+
+Note that you will consume more bandwith this way than uploading from a local
+branch.
+
+Collaborating
+-------------
+
+While we don't have any platform setup, you can branch from trunk:
+
+ bzr branch lp:bzr-upload
+
+And change anything you'd like, and get in touch with any of the authors to
+review and add the changes.
+
+
+Known Issues
+------------
+
+ * Symlinks are not supported
+
+
"""
# TODO: the chmod bits *can* be supported via the upload protocols
@@ -367,6 +464,7 @@
Changes include files added, renamed, modified or removed.
"""
+ _see_also = ['plugins/upload']
takes_args = ['location?']
takes_options = [
'revision',
More information about the bazaar-commits
mailing list