Trivial documentation patch

[jw schultz]

On Fri, Oct 24, 2003 at 07:35:48PM +0000, Jon Jensen wrote:
> Greetings.
> 
> I'm not sure if this is the place or not, but I wanted to pass on this
> patch (against CVS as of today) to document two exit values that are used
> by rsync but not yet in the docs. Please let me know if there's a better
> place to send it.

You sent to the right place.

It is a good patch.  Thank you very much.  All the exit
codes should be so documented and i assume that this patch
does that.

I just wonder, having had my attention brought to this part
of the manpage, what value it is to have the RERR_* names in
the manpage.  They are internal names with no bearing
outside the source code.  It seems to me that it would be
more readable if we just gave the numbers and meaning like
so:
       
|      1      Syntax or usage error
|
|      2      Protocol incompatibility
|
|      3      Errors selecting input/output files, dirs
|
|      4      Requested action not supported: an attempt was made
|             to manipulate 64-bit files on a platform that  can­
|             not  support  them; or an option was speciifed that

Perhaps someone who knows yodl could make that change.

> Many thanks to the developers and maintainers of rsync for all the 
> excellent work!
> 
> Jon
> 
> 
> Index: rsync.yo
> ===================================================================
> RCS file: /cvsroot/rsync/rsync.yo,v
> retrieving revision 1.128
> diff -u -r1.128 rsync.yo
> --- rsync.yo	7 Oct 2003 20:33:08 -0000	1.128
> +++ rsync.yo	24 Oct 2003 19:33:09 -0000
> @@ -1109,15 +1109,17 @@
>  manpagesection(EXIT VALUES)
>  
>  startdit()
> -dit(bf(RERR_SYNTAX     1))       Syntax or usage error 
> -dit(bf(RERR_PROTOCOL   2))       Protocol incompatibility 
> -dit(bf(RERR_FILESELECT 3))       Errors selecting input/output files, dirs
> +dit(bf(RERR_SYNTAX      1))      Syntax or usage error
> +dit(bf(RERR_PROTOCOL    2))      Protocol incompatibility
> +dit(bf(RERR_FILESELECT  3))      Errors selecting input/output files, dirs
>  
>  dit(bf(RERR_UNSUPPORTED 4)) Requested action not supported: an attempt
>  was made to manipulate 64-bit files on a platform that cannot support
>  them; or an option was speciifed that is supported by the client and
>  not by the server.
>  
> +dit(bf(RERR_STARTCLIENT 5))      Error starting client-server protocol
> +
>  dit(bf(RERR_SOCKETIO   10))      Error in socket IO 
>  dit(bf(RERR_FILEIO     11))      Error in file IO 
>  dit(bf(RERR_STREAMIO   12))      Error in rsync protocol data stream 
> @@ -1126,6 +1128,7 @@
>  dit(bf(RERR_SIGNAL     20))      Received SIGUSR1 or SIGINT 
>  dit(bf(RERR_WAITCHILD  21))      Some error returned by waitpid() 
>  dit(bf(RERR_MALLOC     22))      Error allocating core memory buffers 
> +dit(bf(RERR_PARTIAL    23))      Partial transfer
>  dit(bf(RERR_TIMEOUT    30))      Timeout in data send/receive 
>  enddit()
>  
> -- 
> To unsubscribe or change options: http://lists.samba.org/mailman/listinfo/rsync
> Before posting, read: http://www.catb.org/~esr/faqs/smart-questions.html
> 

-- 
________________________________________________________________
	J.W. Schultz            Pegasystems Technologies
	email address:		jw at pegasys.ws

		Remember Cernan and Schmitt