[SCM] Samba Shared Repository - branch master updated
Derrell Lipman
derrell at samba.org
Sun Apr 11 09:37:23 MDT 2010
The branch, master has been updated
via 0ee1985... [Bug 7345] Incomplete description of function return values in libsmbclient.h
from 59d6889... s3: Use sizeof(chal) instead of a constant
http://gitweb.samba.org/?p=samba.git;a=shortlog;h=master
- Log -----------------------------------------------------------------
commit 0ee1985b05bd1a650f712a6d458b20c31eae8734
Author: Derrell Lipman <derrell at dworkin.(none)>
Date: Sun Apr 11 11:37:00 2010 -0400
[Bug 7345] Incomplete description of function return values in libsmbclient.h
- Fixed documentation on smbc_fstat(), smbc_statvfs(), and smbc_fstatvfs():
All were missing return value upon success
- Fixed documentation on smbc_read:
Documented return value upon EOF
Derrell
-----------------------------------------------------------------------
Summary of changes:
source3/include/libsmbclient.h | 22 ++++++++++++++--------
1 files changed, 14 insertions(+), 8 deletions(-)
Changeset truncated at 500 lines:
diff --git a/source3/include/libsmbclient.h b/source3/include/libsmbclient.h
index dd6f93e..978f657 100644
--- a/source3/include/libsmbclient.h
+++ b/source3/include/libsmbclient.h
@@ -1267,13 +1267,15 @@ int smbc_creat(const char *furl, mode_t mode);
*
* @param bufsize Size of buf in bytes
*
- * @return Number of bytes read, < 0 on error with errno set:
+ * @return Number of bytes read;
+ * 0 upon EOF;
+ * < 0 on error, with errno set:
* - EISDIR fd refers to a directory
* - EBADF fd is not a valid file descriptor or
- * is not open for reading.
+ * is not open for reading.
* - EINVAL fd is attached to an object which is
- * unsuitable for reading, or no buffer passed or
- * smbc_init not called.
+ * unsuitable for reading, or no buffer passed or
+ * smbc_init not called.
*
* @see smbc_open(), smbc_write()
*
@@ -1618,7 +1620,8 @@ int smbc_stat(const char *url, struct stat *st);
* @param st pointer to a buffer that will be filled with
* standard Unix struct stat information.
*
- * @return EBADF filedes is bad.
+ * @return 0 on success, < 0 on error with errno set:
+ * - EBADF filedes is bad.
* - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines
@@ -1639,7 +1642,8 @@ int smbc_fstat(int fd, struct stat *st);
* @param st pointer to a buffer that will be filled with
* standard Unix struct statvfs information.
*
- * @return EBADF filedes is bad.
+ * @return 0 on success, < 0 on error with errno set:
+ * - EBADF filedes is bad.
* - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines
@@ -1662,7 +1666,8 @@ smbc_statvfs(char *url,
* @param st pointer to a buffer that will be filled with
* standard Unix struct statvfs information.
*
- * @return EBADF filedes is bad.
+ * @return 0 on success, < 0 on error with errno set:
+ * - EBADF filedes is bad.
* - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines
@@ -1684,7 +1689,8 @@ smbc_fstatvfs(int fd,
*
* @param size size to truncate the file to
*
- * @return EBADF filedes is bad.
+ * @return 0 on success, < 0 on error with errno set:
+ * - EBADF filedes is bad.
* - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines
--
Samba Shared Repository
More information about the samba-cvs
mailing list