Commit aa5d6729 authored by Brian Sutherland's avatar Brian Sutherland

Whitespace, formatting and spelling.

parent ffaaccea
...@@ -17,7 +17,7 @@ example, if we are creating an application named "Foo", then "the Foo ...@@ -17,7 +17,7 @@ example, if we are creating an application named "Foo", then "the Foo
buildout" is the collection of configuration and application-specific buildout" is the collection of configuration and application-specific
software that allows an instance of the application to be created. We software that allows an instance of the application to be created. We
may refer to such an instance of the application informally as "a Foo may refer to such an instance of the application informally as "a Foo
buildout". buildout".
To get a feel for some of the things you might use buildouts for, see To get a feel for some of the things you might use buildouts for, see
the `Buildout examples`_. the `Buildout examples`_.
...@@ -110,7 +110,7 @@ is in the src directory. The configuration file is very simple:: ...@@ -110,7 +110,7 @@ is in the src directory. The configuration file is very simple::
I use the develop option to create a develop egg based on the current I use the develop option to create a develop egg based on the current
directory. I request a test script named "test" using the directory. I request a test script named "test" using the
zc.recipe.testrunner recipe. In the section for the test script, I zc.recipe.testrunner recipe. In the section for the test script, I
specify that I want to run the tests in the zc.ngi package. specify that I want to run the tests in the zc.ngi package.
When I check out this project into a new sandbox, I run bootstrap.py When I check out this project into a new sandbox, I run bootstrap.py
to get setuptools and zc.buildout and create bin/buildout. I run to get setuptools and zc.buildout and create bin/buildout. I run
...@@ -140,7 +140,7 @@ a buildout with a configuration file that looks like:: ...@@ -140,7 +140,7 @@ a buildout with a configuration file that looks like::
whwre foo and bar are packages with scripts that I want available. As whwre foo and bar are packages with scripts that I want available. As
I need new scripts, I can add additional sections. The bin-directory I need new scripts, I can add additional sections. The bin-directory
option specified that scripts should be installed into the current option specified that scripts should be installed into the current
directory. directory.
Multi-program multi-machine systems Multi-program multi-machine systems
=================================== ===================================
...@@ -161,7 +161,7 @@ typical example consists of: ...@@ -161,7 +161,7 @@ typical example consists of:
- Multiple test runners - Multiple test runners
- Multiple deployment modes, including dev, stage, and prod, - Multiple deployment modes, including dev, stage, and prod,
with prod deployment over multiple servers with prod deployment over multiple servers
Parts installed include: Parts installed include:
...@@ -179,7 +179,7 @@ Parts installed include: ...@@ -179,7 +179,7 @@ Parts installed include:
Questions and Bug Reporting Questions and Bug Reporting
*************************** ***************************
Please send questions and comments to the Please send questions and comments to the
`distutils SIG mailing list <mailto://distutils-sig@python.org>`_. `distutils SIG mailing list <mailto://distutils-sig@python.org>`_.
Report bugs using the `zc.buildout Launchpad Bug Tracker Report bugs using the `zc.buildout Launchpad Bug Tracker
......
...@@ -5,7 +5,7 @@ The zc.recipe.egg recipe can be used to install various types if ...@@ -5,7 +5,7 @@ The zc.recipe.egg recipe can be used to install various types if
distutils distributions as eggs. It takes a number of options: distutils distributions as eggs. It takes a number of options:
eggs eggs
A list of eggs to install given as one ore more setuptools A list of eggs to install given as one or more setuptools
requirement strings. Each string must be given on a separate requirement strings. Each string must be given on a separate
line. line.
...@@ -20,14 +20,14 @@ index ...@@ -20,14 +20,14 @@ index
alternate index with this option. If you use the links option and alternate index with this option. If you use the links option and
if the links point to the needed distributions, then the index can if the links point to the needed distributions, then the index can
be anything and will be largely ignored. In the examples, here, be anything and will be largely ignored. In the examples, here,
we'll just point to an empty directory on our link server. This we'll just point to an empty directory on our link server. This
will make our examples run a little bit faster. will make our examples run a little bit faster.
python python
The name of a section to get the Python executable from. The name of a section to get the Python executable from.
If not specified, then the buildout python option is used. The If not specified, then the buildout python option is used. The
Python executable is found in the executable option of the named Python executable is found in the executable option of the named
section. section.
entry-points entry-points
A list of entry-point identifiers of the form name=module#attrs, A list of entry-point identifiers of the form name=module#attrs,
...@@ -67,7 +67,7 @@ We have a link server that has a number of distributions: ...@@ -67,7 +67,7 @@ We have a link server that has a number of distributions:
We have a sample buildout. Let's update it's configuration file to We have a sample buildout. Let's update it's configuration file to
install the demo package. install the demo package.
>>> write(sample_buildout, 'buildout.cfg', >>> write(sample_buildout, 'buildout.cfg',
... """ ... """
...@@ -95,7 +95,7 @@ Let's run the buildout: ...@@ -95,7 +95,7 @@ Let's run the buildout:
zc.buildout.easy_install: Got demo 0.2 zc.buildout.easy_install: Got demo 0.2
zc.buildout.easy_install: Getting new distribution for demoneeded zc.buildout.easy_install: Getting new distribution for demoneeded
zc.buildout.easy_install: Got demoneeded 1.1 zc.buildout.easy_install: Got demoneeded 1.1
Now, if we look at the buildout eggs directory: Now, if we look at the buildout eggs directory:
>>> ls(sample_buildout, 'eggs') >>> ls(sample_buildout, 'eggs')
...@@ -105,7 +105,7 @@ Now, if we look at the buildout eggs directory: ...@@ -105,7 +105,7 @@ Now, if we look at the buildout eggs directory:
- zc.buildout-1.0-py2.3.egg - zc.buildout-1.0-py2.3.egg
We see that we got an egg for demo that met the requirement, as well We see that we got an egg for demo that met the requirement, as well
as the egg for demoneeded, wich demo requires. (We also see an egg as the egg for demoneeded, which demo requires. (We also see an egg
link for the recipe. This egg link was actually created as part of link for the recipe. This egg link was actually created as part of
the sample buildout setup. Normally, when using the recipe, you'll get the sample buildout setup. Normally, when using the recipe, you'll get
a regular egg installation.) a regular egg installation.)
...@@ -276,7 +276,7 @@ extra-paths option: ...@@ -276,7 +276,7 @@ extra-paths option:
... find-links = %(server)s ... find-links = %(server)s
... index = %(server)s/index ... index = %(server)s/index
... scripts = demo=foo ... scripts = demo=foo
... extra-paths = ... extra-paths =
... /foo/bar ... /foo/bar
... /spam/eggs ... /spam/eggs
... """ % dict(server=link_server)) ... """ % dict(server=link_server))
...@@ -306,9 +306,8 @@ Let's look at the script that was generated: ...@@ -306,9 +306,8 @@ Let's look at the script that was generated:
Specifying entry points Specifying entry points
----------------------- -----------------------
Scripts can be generated for entry points declared explcitly. We can Scripts can be generated for entry points declared explicitly. We can
declate entry points using the entry-points option: declare entry points using the entry-points option:
>>> write(sample_buildout, 'buildout.cfg', >>> write(sample_buildout, 'buildout.cfg',
... """ ... """
...@@ -319,7 +318,7 @@ declate entry points using the entry-points option: ...@@ -319,7 +318,7 @@ declate entry points using the entry-points option:
... recipe = zc.recipe.egg ... recipe = zc.recipe.egg
... find-links = %(server)s ... find-links = %(server)s
... index = %(server)s/index ... index = %(server)s/index
... extra-paths = ... extra-paths =
... /foo/bar ... /foo/bar
... /spam/eggs ... /spam/eggs
... entry-points = alt=eggrecipedemo:alt other=foo.bar:a.b.c ... entry-points = alt=eggrecipedemo:alt other=foo.bar:a.b.c
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment