You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by Robbie Gemmell <ro...@gmail.com> on 2010/11/22 17:51:42 UTC
Re: svn commit: r1037771 - /qpid/trunk/qpid/python/README.txt
I dont think replacing <install-prefix> with /home/me is the right
thing to do here, the former simply implies wherever the user
installed it rather than a specific directory and seems the more
appropriate. Replacing <version> with 0.8 also isnt actually all that
helppful in my view, and will probably only lead to it being out of
date at some point in future, so I would be inclined to leave that
alone too.
Robbie
On 22 November 2010 16:38, <jo...@apache.org> wrote:
> Author: jonathan
> Date: Mon Nov 22 16:38:34 2010
> New Revision: 1037771
>
> URL: http://svn.apache.org/viewvc?rev=1037771&view=rev
> Log:
> Corrected instructions for running Python clients - now matches 0.8 distribution.
>
> Modified:
> qpid/trunk/qpid/python/README.txt
>
> Modified: qpid/trunk/qpid/python/README.txt
> URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/python/README.txt?rev=1037771&r1=1037770&r2=1037771&view=diff
> ==============================================================================
> --- qpid/trunk/qpid/python/README.txt (original)
> +++ qpid/trunk/qpid/python/README.txt Mon Nov 22 16:38:34 2010
> @@ -1,24 +1,23 @@
> -= INSTALLATION =
> += GETTING STARTED =
>
> -Extract the release archive into a directory of your choice and set
> -your PYTHONPATH accordingly:
> +1. Make sure the Qpid Python client libraries are on your PYTHONPATH:
>
> - tar -xzf qpid-python-<version>.tar.gz -C <install-prefix>
> - export PYTHONPATH=<install-prefix>/qpid-<version>/python
> +$ export PYTHONPATH=/home/me/qpid-0.8/python
>
> -= GETTING STARTED =
> +2. Make sure a broker is running
>
> -The python client includes a simple hello-world example that publishes
> -and consumes a message:
> +3. Run the 'hello' example from qpid-0.8/python/examples/api:
> +
> +$ ./hello
> +Hello world!
>
> - cp <install-prefix>/qpid-<version>/python/hello-world .
> - ./hello-world
>
> = EXAMPLES =
>
> -More comprehensive examples can be found here:
> +The examples/api directory contains several examples.
> +
> +Read examples/README.txt for further details on these examples.
>
> - cd <install-prefix>/qpid-<version>/python/examples
>
> = RUNNING THE TESTS =
>
>
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:commits-subscribe@qpid.apache.org
>
>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: svn commit: r1037771 - /qpid/trunk/qpid/python/README.txt
Posted by Andrew Kennedy <an...@gmail.com>.
On 22 November 2010 17:04, Jonathan Robie <jo...@redhat.com> wrote:
> By the time someone reads this README, they have already extracted the
> archive. I think what we really want to do is tell them to set it to the
> place they have extracted it to.
>
> Perhaps /path/to instead of /home/me?
>
> I actually prefer 0.8 instead of <version>. I don't think we have ever had
> two consecutive versions where these instructions worked without change,
> someone has to review them each time anyway. If there's a fixed release
> number, it makes it that much more obvious that we need to do this.
I still think using a placeholder, either <install-directory> or even
another environment variable, would be clearer. Also, I think we
should aim for documentation that works now, but with the intention
that it does *NOT* need changed every release and will, rather,
continue working...
Andrew.
--
-- andrew d kennedy ? edinburgh : +44 7941 197 134
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: svn commit: r1037771 - /qpid/trunk/qpid/python/README.txt
Posted by Jonathan Robie <jo...@redhat.com>.
By the time someone reads this README, they have already extracted the
archive. I think what we really want to do is tell them to set it to the
place they have extracted it to.
Perhaps /path/to instead of /home/me?
I actually prefer 0.8 instead of <version>. I don't think we have ever
had two consecutive versions where these instructions worked without
change, someone has to review them each time anyway. If there's a fixed
release number, it makes it that much more obvious that we need to do this.
Jonathan
On 11/22/2010 11:51 AM, Robbie Gemmell wrote:
> I dont think replacing<install-prefix> with /home/me is the right
> thing to do here, the former simply implies wherever the user
> installed it rather than a specific directory and seems the more
> appropriate. Replacing<version> with 0.8 also isnt actually all that
> helppful in my view, and will probably only lead to it being out of
> date at some point in future, so I would be inclined to leave that
> alone too.
>
> Robbie
>
> On 22 November 2010 16:38,<jo...@apache.org> wrote:
>> Author: jonathan
>> Date: Mon Nov 22 16:38:34 2010
>> New Revision: 1037771
>>
>> URL: http://svn.apache.org/viewvc?rev=1037771&view=rev
>> Log:
>> Corrected instructions for running Python clients - now matches 0.8 distribution.
>>
>> Modified:
>> qpid/trunk/qpid/python/README.txt
>>
>> Modified: qpid/trunk/qpid/python/README.txt
>> URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/python/README.txt?rev=1037771&r1=1037770&r2=1037771&view=diff
>> ==============================================================================
>> --- qpid/trunk/qpid/python/README.txt (original)
>> +++ qpid/trunk/qpid/python/README.txt Mon Nov 22 16:38:34 2010
>> @@ -1,24 +1,23 @@
>> -= INSTALLATION =
>> += GETTING STARTED =
>>
>> -Extract the release archive into a directory of your choice and set
>> -your PYTHONPATH accordingly:
>> +1. Make sure the Qpid Python client libraries are on your PYTHONPATH:
>>
>> - tar -xzf qpid-python-<version>.tar.gz -C<install-prefix>
>> - export PYTHONPATH=<install-prefix>/qpid-<version>/python
>> +$ export PYTHONPATH=/home/me/qpid-0.8/python
>>
>> -= GETTING STARTED =
>> +2. Make sure a broker is running
>>
>> -The python client includes a simple hello-world example that publishes
>> -and consumes a message:
>> +3. Run the 'hello' example from qpid-0.8/python/examples/api:
>> +
>> +$ ./hello
>> +Hello world!
>>
>> - cp<install-prefix>/qpid-<version>/python/hello-world .
>> - ./hello-world
>>
>> = EXAMPLES =
>>
>> -More comprehensive examples can be found here:
>> +The examples/api directory contains several examples.
>> +
>> +Read examples/README.txt for further details on these examples.
>>
>> - cd<install-prefix>/qpid-<version>/python/examples
>>
>> = RUNNING THE TESTS =
>>
>>
>>
>>
>> ---------------------------------------------------------------------
>> Apache Qpid - AMQP Messaging Implementation
>> Project: http://qpid.apache.org
>> Use/Interact: mailto:commits-subscribe@qpid.apache.org
>>
>>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: svn commit: r1037771 - /qpid/trunk/qpid/python/README.txt
Posted by Andrew Kennedy <an...@gmail.com>.
On 22 November 2010 16:51, Robbie Gemmell <ro...@gmail.com> wrote:
> I dont think replacing <install-prefix> with /home/me is the right
> thing to do here, the former simply implies wherever the user
> installed it rather than a specific directory and seems the more
> appropriate. Replacing <version> with 0.8 also isnt actually all that
> helppful in my view, and will probably only lead to it being out of
> date at some point in future, so I would be inclined to leave that
> alone too.
>
> Robbie
Yes, I'd rather see versions and directories as placeholders, as in
the original, and I would also have expected the command to be
something like:
$ export PYTHONPATH=${PYTHONPATH}:<install-prefix>/qpid-<version>/python
Since the user may already have PYTHONPATH entries set.
Andrew.
--
-- andrew d kennedy ? edinburgh : +44 7941 197 134
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org