[PATCH] Document functions xmemdupz(), xread() and xwrite()

[PATCH] Document functions xmemdupz(), xread() and xwrite()

[Heikki Orsila]

Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>
---
This is version 2 of the documentation patch. Compared to version 1,
xwrite() behavior is documented explicitly.

 git-compat-util.h |   16 ++++++++++++++++
 1 files changed, 16 insertions(+), 0 deletions(-)

diff --git a/git-compat-util.h b/git-compat-util.h
index a18235e..167c3fe 100644
--- a/git-compat-util.h
+++ b/git-compat-util.h
@@ -268,6 +268,12 @@ static inline void *xmalloc(size_t size)
 	return ret;
 }
 
+/*
+ * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
+ * "data" to the allocated memory, zero terminates the allocated memory,
+ * and returns a pointer to the allocated memory. If the allocation fails,
+ * the program dies.
+ */
 static inline void *xmemdupz(const void *data, size_t len)
 {
 	char *p = xmalloc(len + 1);
@@ -329,6 +335,11 @@ static inline void *xmmap(void *start, size_t length,
 	return ret;
 }
 
+/*
+ * xread() is the same a read(), but it automatically restarts read()
+ * operations with a recoverable error (EAGAIN and EINTR). xread()
+ * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
+ */
 static inline ssize_t xread(int fd, void *buf, size_t len)
 {
 	ssize_t nr;
@@ -340,6 +351,11 @@ static inline ssize_t xread(int fd, void *buf, size_t len)
 	}
 }
 
+/*
+ * xwrite() is the same a write(), but it automatically restarts write()
+ * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
+ * GUARANTEE that "len" bytes is written even if the operation is successful.
+ */
 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 {
 	ssize_t nr;
-- 
1.5.4.4

[PATCH] Document functions xmemdupz(), xread() and xwrite()

[Heikki Orsila]

Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>
---
 git-compat-util.h |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/git-compat-util.h b/git-compat-util.h
index a18235e..7498bee 100644
--- a/git-compat-util.h
+++ b/git-compat-util.h
@@ -268,6 +268,12 @@ static inline void *xmalloc(size_t size)
 	return ret;
 }
 
+/*
+ * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
+ * "data" to the allocated memory, zero terminates the allocated memory,
+ * and returns a pointer to the allocated memory. If the allocation fails,
+ * the program dies.
+ */
 static inline void *xmemdupz(const void *data, size_t len)
 {
 	char *p = xmalloc(len + 1);
@@ -329,6 +335,11 @@ static inline void *xmmap(void *start, size_t length,
 	return ret;
 }
 
+/*
+ * xread() is the same a read(), but it automatically restarts read()
+ * operations with a recoverable error (EAGAIN and EINTR). xread()
+ * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
+ */
 static inline ssize_t xread(int fd, void *buf, size_t len)
 {
 	ssize_t nr;
@@ -340,6 +351,9 @@ static inline ssize_t xread(int fd, void *buf, size_t len)
 	}
 }
 
+/*
+ * xwrite() is similar to xread()
+ */
 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 {
 	ssize_t nr;
-- 
1.5.4.4

Re: [PATCH] Document functions xmemdupz(), xread() and xwrite()

[Junio C Hamano]

Heikki Orsila <heikki.orsila@iki.fi> writes:

> Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>
> ---
>  git-compat-util.h |   14 ++++++++++++++
>  1 files changed, 14 insertions(+), 0 deletions(-)
>
> diff --git a/git-compat-util.h b/git-compat-util.h
> index a18235e..7498bee 100644
> --- a/git-compat-util.h
> +++ b/git-compat-util.h
> @@ -268,6 +268,12 @@ static inline void *xmalloc(size_t size)
>  	return ret;
>  }
>  
> +/*
> + * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
> + * "data" to the allocated memory, zero terminates the allocated memory,
> + * and returns a pointer to the allocated memory. If the allocation fails,
> + * the program dies.
> + */

Ok.

>  static inline void *xmemdupz(const void *data, size_t len)
>  {
>  	char *p = xmalloc(len + 1);
> @@ -329,6 +335,11 @@ static inline void *xmmap(void *start, size_t length,
>  	return ret;
>  }
>  
> +/*
> + * xread() is the same a read(), but it automatically restarts read()
> + * operations with a recoverable error (EAGAIN and EINTR). xread()
> + * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
> + */

Ok.

>  static inline ssize_t xread(int fd, void *buf, size_t len)
>  {
>  	ssize_t nr;
> @@ -340,6 +351,9 @@ static inline ssize_t xread(int fd, void *buf, size_t len)
>  	}
>  }
>  
> +/*
> + * xwrite() is similar to xread()
> + */

Well, up to "how recoverable errors are handled" they may be similar but
would the last sentence apply to it as well, or does it need rewording?

>  static inline ssize_t xwrite(int fd, const void *buf, size_t len)
>  {
>  	ssize_t nr;
> -- 
> 1.5.4.4