Commits

Anonymous committed 52d8932

documentation updates

Comments (0)

Files changed (1)

 B<Hg::Lib> is an interface to B<mercurial>'s command
 server. (B<mercurial> is a distributed version control system (DVCS)
 tool. See L</REFERENCES> for links to  detailed discussions of both
-B<mercurial> and its the command server. )
+B<mercurial> and its the command server.)
 
 B<mercurial> officially supports two interfaces for interacting with
 it: the command line, and its built-in command server.  The command
 server runs alongside the controlling program; communications between
-the two are done via the server's standard input and output streams.
-Multiple commands may be issued, reducing the overhead of starting up
-B<mercurial> for each command.  The syntax for using the command
-server is very similar to issuing commands to the B<hg> program on the
-command line.
+the two is via the server's standard input and output streams.
+Multiple sequential commands may be issued to the server, reducing the
+overhead of starting up B<mercurial> for each command.  The syntax for
+using the command server is very similar to issuing commands to the
+B<hg> program on the command line.
 
 B<Hg::Lib> manages the start and stop of the server, and marshals
 communications between it and user code.  It encapsulates the
 interaction with the server in an B<Hg::Lib::CLient> object, whose
 methods mirror B<hg>'s commands.
 
-=head2 Usage
+
+
+=head1 FUNCTIONS
 
 There are three functions in B<Hg::Lib>:
 
 =over
 
-=item B<open>
+=item *
 
-Operate on an existing repository.
+B<open> operates on an existing repository.
 
-=item B<init>
+=item *
 
-Create a new, empty repository and operate on that
+B<init> creates a new, empty repository and operates on that
 
-=item B<clone>
+=item *
 
-Clone an existing repository and operate on the clone
+B<clone> clones an existing repository and operates on the clone
 
 =back
 
-Due to limitations in the command server, it only works with an
-existing repository.  The B<init> and B<clone> functions first use
-B<hg> to create the new repository, then start the command server,
-operating on the new repository.
+B<mercurial>'s command server only works with an existing repository.
+The B<init> and B<clone> functions first create the new repository
+using B<hg>, and then start the command server.
 
-Each function returns an B<Hg::Lib::Client> object, which is used to
+Each function returns an B<Hg::Lib::Client> object which is used to
 control the server.  By default the server is not actually started
 until the client sends it a request.  The C<connect> attribute may be
 used to change this behavior.
 
 
-=head1 FUNCTIONS
-
 =over
 
 =item B<open>
 
   $client = Hg::Lib::open( %args );
 
-Create a client associated with an existing repository.
+Create a client associated with an existing repository.  Throws an
+B<Hg::Lib::Exception> object open error.
 
 The following named arguments are available:
 
 
   $client = Hg::Lib::init( %args );
 
-Initialize a fresh repository and return a client associated with it.
+Initialize a fresh repository and return a client associated with it.  Throws an
+B<Hg::Lib::Exception> object open error.
 
 The following named arguments are available:
 
 
   $client = Hg::Lib::clone( source => $source, %args );
 
-Clone an existing repository and create a client associated
-with the clone.
+Clone an existing repository and create a client associated with the
+clone.  Throws an B<Hg::Lib::Exception> object open error.
 
 The following named arguments are available:
 
 
 =item C<dest> I<directory name>
 
-Optional. The name of the directory which will contain the new repository.  If
+The name of the directory which will contain the new repository.  If
 not specified, a new directory (named after the basename of the source)
 containing the clone is created in the current directory.  I<(Optional)>.