[Bps-public-commit] r15229 - in Shipwright/trunk: .
sunnavy at bestpractical.com
sunnavy at bestpractical.com
Mon Aug 18 11:55:56 EDT 2008
Author: sunnavy
Date: Mon Aug 18 11:55:52 2008
New Revision: 15229
Modified:
Shipwright/trunk/ (props changed)
Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod
Log:
r15811 at sunnavys-mb: sunnavy | 2008-08-18 23:55:12 +0800
use svn as sample repository; also other tiny changes
Modified: Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod (original)
+++ Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod Mon Aug 18 11:55:52 2008
@@ -17,13 +17,17 @@
svk:/test/foo
fs:/tmp/foo
-we'll use C<svk://foo> as the repository for the rest tutorial.
+we'll use C<svn:file:///tmp/svnrepo/foo> as the repository for the rest tutorial.
=head2 create
-First, let's initialize the repository of the project:
+We need to create the svn repo first:
- $ shipwright create -r svk://foo
+ $ svnadmin create /tmp/svnrepo
+
+Then we can initialize the repository of our Shipwrihgt project:
+
+ $ shipwright create -r svn:file:///tmp/svnrepo/foo
For the layout of shipwright's source, see L<Shipwright>.
@@ -63,7 +67,7 @@
=item SVK
- svk://foo>
+ svn:file:///tmp/svnrepo/foo>
svk:/test/foo
=item SVN
@@ -76,7 +80,7 @@
cpan:Jifty
cpan:Module::Install
-It's ok, Shipwright will find the download link automatically for you,
+It's ok, Shipwright will find the download link automatically for us,
with L<CPAN>'s help.
=item Shipwright
@@ -85,25 +89,27 @@
shipwright:svk:/shipwright/repo/bar
svk:/shipwright/repo is another shipwright repository, 'foo' or 'bar' is the
-dist name you want to import.
+dist name we want to import.
=back
We'll import apache 2.2.9, perl 5.10, mod_perl 2.0, libxml and XML::LibXML
in this tutorial one by one.
- $ shipwright import -r svk://foo http://www.apache.org/dist/httpd/httpd-2.2.9.tar.gz --name apache
- $ shipwright import -r svk://foo http://www.cpan.org/authors/id/R/RG/RGARCIA/perl-5.10.0.tar.gz
- $ shipwright import -r svk://foo http://perl.apache.org/dist/mod_perl-2.0-current.tar.gz --name mod_perl
- $ shipwright import -r svk://foo ftp://xmlsoft.org/libxml2/libxml2-2.6.32.tar.gz --name libxml
- $ shipwright import -r svk://foo cpan:XML::LibXML
+ $ shipwright import -r svn:file:///tmp/svnrepo/foo http://www.apache.org/dist/httpd/httpd-2.2.9.tar.gz --name apache
+ $ shipwright import -r svn:file:///tmp/svnrepo/foo http://www.cpan.org/authors/id/R/RG/RGARCIA/perl-5.10.0.tar.gz
+ $ shipwright import -r svn:file:///tmp/svnrepo/foo http://perl.apache.org/dist/mod_perl-2.0-current.tar.gz --name mod_perl --no-follow
+ ( use --no-follow is because run Makefile.PL will hung if we don't have
+ apache installed )
+ $ shipwright import -r svn:file:///tmp/svnrepo/foo ftp://xmlsoft.org/libxml2/libxml2-2.6.32.tar.gz --name libxml
+ $ shipwright import -r svn:file:///tmp/svnrepo/foo cpan:XML::LibXML
Run I<shipwright help import> to see more options.
-As a side note, if you were importing from a source that doesn't use a build
+As a side note, if we were importing from a source that doesn't use a build
mechanism that Shipwright can automatically create a set of build instructions
for (currently I<autoconf>, L<ExtUtils::MakeMaker>, L<Module::Install>, and
-L<Module::Build>), you would now need to edit F<scripts/DISTNAME/build> to tell
+L<Module::Build>), we would now need to edit F<scripts/DISTNAME/build> to tell
Shipwright how to build that source.
For our tutorial, e.g. perl 5.10, the build can't be created automitacally,
@@ -120,12 +126,12 @@
For dists with I<CPAN>, I<SVK>, I<SVN> and I<Shipwright> types,
we can simply use the I<update> cmd to update:
- $ shipwright update -r svk://foo cpan-XML-LibXML
+ $ shipwright update -r svn:file:///tmp/svnrepo/foo cpan-XML-LibXML
(yeah, that's right, cpan:XML::LibXML will be named cpan-XML-LibXML)
-you can also specify the version you want to update to with --version arg:
+we can also specify the version we want to update to with --version arg:
- $ shipwright update -r svk://foo cpan-XML-LibXML --version 1.60
+ $ shipwright update -r svn:file:///tmp/svnrepo/foo cpan-XML-LibXML --version 1.60
For other types, Shipwright can't find the latest version, so we have to tell
Shipwright where it is by I<relocate> cmd.
@@ -134,8 +140,8 @@
L<http://apache.mirror.phpchina.com/httpd/httpd-2.2.10.tar.gz>, we need to
set the source url first before update.
- $ shipwright relocate -r svk://foo apache http://www.apache.org/dist/httpd/httpd-2.2.10.tar.gz
- $ shipwright update -r svk://foo apache
+ $ shipwright relocate -r svn:file:///tmp/svnrepo/foo apache http://www.apache.org/dist/httpd/httpd-2.2.10.tar.gz
+ $ shipwright update -r svn:file:///tmp/svnrepo/foo apache
=head2 tweak manually
@@ -151,14 +157,14 @@
=head2 build
-There're two ways to build a Shipwright project, you can use Shipwright's
+There're two ways to build a Shipwright project, we can use Shipwright's
I<build> command or use the F</bin/shipwright-builder> in the repository.
=over 4
=item build cmd
-$ shipwright build -r svk://foo
+$ shipwright build -r svn:file:///tmp/svnrepo/foo
You can tell Shipwright the dir to install to by C<--install-base> arg.
@@ -176,22 +182,22 @@
=back
-=head2 ship your vessel
+=head2 ship our vessel
We call the built stuff the I<vessel>.
-To ship your vessel, create an archive of the built files using an archive
-program such as I<tar>, e.g. by running I<tar czvf your-vessel.tar.gz
-/tmp/your-vessel>.
+To ship our vessel, create an archive of the built files using an archive
+program such as I<tar>, e.g. by running I<tar czvf our-vessel.tar.gz
+/tmp/our-vessel>.
-Users can use your vessel by extracting the archive to a directory and then
+Users can use our vessel by extracting the archive to a directory and then
adding the following command to their shell's startup script
(e.g. for bash users, edit F</home/user/.bashrc> on most systems): I<source
/base/path/hello/etc/shipwright-source-bash> (for bash users). A source script
is also provided for the tcsh shell.
After sourcing this script, users will be able to run binaries and load perl
-modules from your vessel as with normal installed programs, though they will
+modules from our vessel as with normal installed programs, though they will
need to start a new shell or re-run their startup script.
=head1 SEE ALSO
More information about the Bps-public-commit
mailing list