From 34e8ca25fda9b46a058d3307d1c545e1da853014 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 20 Dec 2009 21:45:48 +0100 Subject: [PATCH 1/1] minor doc fixes for liboping Hello, I was reading the documentation of your liboping library as I'd like to use it for a small project of mine and couldn't help noticing a few typos in the docs, please find attached a tiny patch fixing them. Thanks for writing this library! VZ Signed-off-by: Florian Forster --- src/mans/liboping.pod | 4 ++-- src/mans/oping.pod | 2 +- src/mans/ping_construct.pod | 2 +- src/mans/ping_get_error.pod | 2 +- src/mans/ping_host_add.pod | 2 +- src/mans/ping_iterator_get.pod | 2 +- src/mans/ping_iterator_get_context.pod | 2 +- src/mans/ping_iterator_get_info.pod | 2 +- src/mans/ping_send.pod | 4 ++-- src/mans/ping_setopt.pod | 6 +++--- 10 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/mans/liboping.pod b/src/mans/liboping.pod index a9caa03..d2c42f9 100644 --- a/src/mans/liboping.pod +++ b/src/mans/liboping.pod @@ -18,7 +18,7 @@ and protocol independent manner. The interface is simple, object oriented and There are two main types that are used by applications. Both are "opaque types", meaning they are structures that are B completely defined in the header file, so you cannot access the structures' members. You don't need to, -don't do it. These structures are object to change without notice. +don't do it. These structures are subject to change without notice. =over 4 @@ -81,6 +81,6 @@ applicable. =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/oping.pod b/src/mans/oping.pod index 12c3a65..b005b32 100644 --- a/src/mans/oping.pod +++ b/src/mans/oping.pod @@ -72,6 +72,6 @@ L, L, L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_construct.pod b/src/mans/ping_construct.pod index 6ee023d..da082c8 100644 --- a/src/mans/ping_construct.pod +++ b/src/mans/ping_construct.pod @@ -33,6 +33,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_get_error.pod b/src/mans/ping_get_error.pod index 81e725f..df9a015 100644 --- a/src/mans/ping_get_error.pod +++ b/src/mans/ping_get_error.pod @@ -25,6 +25,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_host_add.pod b/src/mans/ping_host_add.pod index bea2c69..254ac35 100644 --- a/src/mans/ping_host_add.pod +++ b/src/mans/ping_host_add.pod @@ -47,6 +47,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_iterator_get.pod b/src/mans/ping_iterator_get.pod index 0704612..860f448 100644 --- a/src/mans/ping_iterator_get.pod +++ b/src/mans/ping_iterator_get.pod @@ -45,6 +45,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_iterator_get_context.pod b/src/mans/ping_iterator_get_context.pod index 1eae4b3..f0585ab 100644 --- a/src/mans/ping_iterator_get_context.pod +++ b/src/mans/ping_iterator_get_context.pod @@ -40,6 +40,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_iterator_get_info.pod b/src/mans/ping_iterator_get_info.pod index e1cd24f..23e123e 100644 --- a/src/mans/ping_iterator_get_info.pod +++ b/src/mans/ping_iterator_get_info.pod @@ -122,6 +122,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_send.pod b/src/mans/ping_send.pod index 33c4f56..8237dae 100644 --- a/src/mans/ping_send.pod +++ b/src/mans/ping_send.pod @@ -22,7 +22,7 @@ page) and call L on each host. =head1 RETURN VALUE -B returns the value of echo replies received or a value less than +B returns the number of echo replies received or a value less than zero if an error occurred. Use L to receive an error message. =head1 SEE ALSO @@ -37,6 +37,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod index ad85979..df9cc59 100644 --- a/src/mans/ping_setopt.pod +++ b/src/mans/ping_setopt.pod @@ -10,7 +10,7 @@ ping_setopt - Set options for a liboping object =head1 DESCRIPTION -The B method sets options that effect all hosts associated with +The B method sets options that apply to all hosts associated with the object I and hosts that are yet to be added to the object. The I argument is a pointer to an I object, as returned by @@ -39,7 +39,7 @@ values are 1 through 255. Default is B. The address family to use. The memory pointed to by I is interpreted as an integer and must be either B, B, or B. This -option only effects hosts that are being added B this option has been +option only affects hosts that are being added B this option has been set. Default is B. If you change this option, and a source address is set (see B) that setting will be reset. @@ -84,6 +84,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster. -- 2.11.0