Author: rooneg
Date: Wed Jan 25 20:23:44 2006
New Revision: 372428
URL: http://svn.apache.org/viewcvs?rev=372428&view=rev
Log:
Merge r356615 into 1.2.x.
Original log message:
Clean up the documentation surrounding the APR_INCOMPLETE status code,
* include/apr_file_info.h
(apr_stat, apr_dir_read): Note that APR_INCOMPLETE can be returned, and
that if it is you can use the finfo->valid bitfield to determine which
parts of the finfo are filled in. Also break some overly long lines.
* include/apr_errno.h
(APR_STATUS_IS_INCOMPLETE): Update docs since this is no longer specific
to the xlate code.
* CHANGES: Note change.
Modified:
apr/apr/branches/1.2.x/CHANGES
apr/apr/branches/1.2.x/include/apr_errno.h
apr/apr/branches/1.2.x/include/apr_file_info.h
Modified: apr/apr/branches/1.2.x/CHANGES
URL: http://svn.apache.org/viewcvs/apr/apr/branches/1.2.x/CHANGES?rev=372428&r1=372427&r2=372428&view=diff
==============================================================================
--- apr/apr/branches/1.2.x/CHANGES (original)
+++ apr/apr/branches/1.2.x/CHANGES Wed Jan 25 20:23:44 2006
@@ -1,5 +1,10 @@
Changes for APR 1.2.3-dev
+ *) Documented that apr_stat and apr_dir_read can return APR_INCOMPLETE,
+ and how to determine which parts of the resulting apr_finfo_t can be
+ used in such a case.
+ [Garrett Rooney]
+
*) Bugfix for apr_pollset_poll() on systems that implement pollsets
using select(2): properly compute the number of signalled desciptors
when one or more of them are both readable and writable.
Modified: apr/apr/branches/1.2.x/include/apr_errno.h
URL: http://svn.apache.org/viewcvs/apr/apr/branches/1.2.x/include/apr_errno.h?rev=372428&r1=372427&r2=372428&view=diff
==============================================================================
--- apr/apr/branches/1.2.x/include/apr_errno.h (original)
+++ apr/apr/branches/1.2.x/include/apr_errno.h Wed Jan 25 20:23:44 2006
@@ -467,8 +467,8 @@
*/
#define APR_STATUS_IS_TIMEUP(s) ((s) == APR_TIMEUP)
/**
- * The character conversion stopped because of an incomplete character or
- * shift sequence at the end of the input buffer.
+ * The operation was incomplete although some processing was performed
+ * and the results are partially valid.
* @warning
* always use this test, as platform-specific variances may meet this
* more than one error code
Modified: apr/apr/branches/1.2.x/include/apr_file_info.h
URL: http://svn.apache.org/viewcvs/apr/apr/branches/1.2.x/include/apr_file_info.h?rev=372428&r1=372427&r2=372428&view=diff
==============================================================================
--- apr/apr/branches/1.2.x/include/apr_file_info.h (original)
+++ apr/apr/branches/1.2.x/include/apr_file_info.h Wed Jan 25 20:23:44 2006
@@ -224,8 +224,13 @@
* @param finfo Where to store the information about the file, which is
* never touched if the call fails.
* @param fname The name of the file to stat.
- * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
+ * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_
+ values
* @param pool the pool to use to allocate the new file.
+ *
+ * @note If @c APR_INCOMPLETE is returned all the fields in @a finfo may
+ * not be filled in, and you need to check the @c finfo->valid bitmask
+ * to verify that what you're looking for is there.
*/
APR_DECLARE(apr_status_t) apr_stat(apr_finfo_t *finfo, const char *fname,
apr_int32_t wanted, apr_pool_t *pool);
@@ -255,9 +260,14 @@
/**
* Read the next entry from the specified directory.
* @param finfo the file info structure and filled in by apr_dir_read
- * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
+ * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_
+ values
* @param thedir the directory descriptor returned from apr_dir_open
* @remark No ordering is guaranteed for the entries read.
+ *
+ * @note If @c APR_INCOMPLETE is returned all the fields in @a finfo may
+ * not be filled in, and you need to check the @c finfo->valid bitmask
+ * to verify that what you're looking for is there.
*/
APR_DECLARE(apr_status_t) apr_dir_read(apr_finfo_t *finfo, apr_int32_t wanted,
apr_dir_t *thedir);