[rtems commit] Filesystem: Revert documentation changes

Sebastian Huber sebh at rtems.org
Fri Dec 14 09:14:24 UTC 2012


Module:    rtems
Branch:    master
Commit:    6d5ba497b19ad6d379c80197b3ce412f981c3321
Changeset: http://git.rtems.org/rtems/commit/?id=6d5ba497b19ad6d379c80197b3ce412f981c3321

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Dec 14 10:13:36 2012 +0100

Filesystem: Revert documentation changes

---

 cpukit/libcsupport/include/rtems/libio.h  |   68 ++++++++++++++--------------
 cpukit/libcsupport/include/rtems/libio_.h |   10 ++--
 2 files changed, 39 insertions(+), 39 deletions(-)

diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h
index 85bcb97..756ae6f 100644
--- a/cpukit/libcsupport/include/rtems/libio.h
+++ b/cpukit/libcsupport/include/rtems/libio.h
@@ -1176,9 +1176,9 @@ typedef struct {
 } rtems_filesystem_limits_and_options_t;
 
 /**
- *  @brief Default Pathconf Settings
+ * @brief Default pathconf settings.
  *
- *  Override in a filesystem.
+ * Override in a filesystem.
  */
 extern const rtems_filesystem_limits_and_options_t
   rtems_filesystem_default_pathconf;
@@ -1551,38 +1551,38 @@ int unmount(
 );
 
 /**
- *  @brief Mounts a File System
- *
- *  The @a source may be a path to the corresponding device file, or @c NULL.
- *  The @a target path must lead to an existing directory, or @c NULL.  
- *  In case @a target is @c NULL, the root file system will be mounted.  
- *  The @a data parameter will be forwarded to the file system
- *  initialization handler.  The file system type is selected by
- *  @a filesystemtype and may be one of
- *  - RTEMS_FILESYSTEM_TYPE_DEVFS,
- *  - RTEMS_FILESYSTEM_TYPE_DOSFS,
- *  - RTEMS_FILESYSTEM_TYPE_FTPFS,
- *  - RTEMS_FILESYSTEM_TYPE_IMFS,
- *  - RTEMS_FILESYSTEM_TYPE_MINIIMFS,
- *  - RTEMS_FILESYSTEM_TYPE_NFS,
- *  - RTEMS_FILESYSTEM_TYPE_RFS, or
- *  - RTEMS_FILESYSTEM_TYPE_TFTPFS.
- *
- *  Only configured or registered file system types are available.  
- *  You can add file system types to your application configuration with
- *  - CONFIGURE_FILESYSTEM_DEVFS,
- *  - CONFIGURE_FILESYSTEM_DOSFS,
- *  - CONFIGURE_FILESYSTEM_FTPFS,
- *  - CONFIGURE_FILESYSTEM_IMFS,
- *  - CONFIGURE_FILESYSTEM_MINIIMFS,
- *  - CONFIGURE_FILESYSTEM_NFS,
- *  - CONFIGURE_FILESYSTEM_RFS, and
- *  - CONFIGURE_FILESYSTEM_TFTPFS.
- *
- *  @see rtems_filesystem_register() and mount_and_make_target_path().
- *
- *  @retval 0 Successful operation.
- *  @retval -1 An error occured.  The @c errno indicates the error.
+ * @brief Mounts a file system at @a target.
+ *
+ * The @a source may be a path to the corresponding device file, or @c NULL.
+ * The @a target path must lead to an existing directory, or @c NULL.
+ * In case @a target is @c NULL, the root file system will be mounted.
+ * The @a data parameter will be forwarded to the file system
+ * initialization handler.  The file system type is selected by
+ * @a filesystemtype and may be one of
+ * - RTEMS_FILESYSTEM_TYPE_DEVFS,
+ * - RTEMS_FILESYSTEM_TYPE_DOSFS,
+ * - RTEMS_FILESYSTEM_TYPE_FTPFS,
+ * - RTEMS_FILESYSTEM_TYPE_IMFS,
+ * - RTEMS_FILESYSTEM_TYPE_MINIIMFS,
+ * - RTEMS_FILESYSTEM_TYPE_NFS,
+ * - RTEMS_FILESYSTEM_TYPE_RFS, or
+ * - RTEMS_FILESYSTEM_TYPE_TFTPFS.
+ *
+ * Only configured or registered file system types are available.
+ * You can add file system types to your application configuration with
+ * - CONFIGURE_FILESYSTEM_DEVFS,
+ * - CONFIGURE_FILESYSTEM_DOSFS,
+ * - CONFIGURE_FILESYSTEM_FTPFS,
+ * - CONFIGURE_FILESYSTEM_IMFS,
+ * - CONFIGURE_FILESYSTEM_MINIIMFS,
+ * - CONFIGURE_FILESYSTEM_NFS,
+ * - CONFIGURE_FILESYSTEM_RFS, and
+ * - CONFIGURE_FILESYSTEM_TFTPFS.
+ *
+ * @see rtems_filesystem_register() and mount_and_make_target_path().
+ *
+ * @retval 0 Successful operation.
+ * @retval -1 An error occured.  The @c errno indicates the error.
  */
 int mount(
   const char                 *source,
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index 7c5a29f..f56926a 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -179,14 +179,14 @@ extern rtems_filesystem_global_location_t rtems_filesystem_global_location_null;
    rtems_libio_check_permissions_with_error(_iop, _flag, EINVAL )
 
 /**
- *  @brief Clones a Node
+ * @brief Clones a node.
  *
- *  The caller must hold the file system instance lock.
+ * The caller must hold the file system instance lock.
  *
- *  @param[out] clone The cloned location.
- *  @param[in] master The master location.
+ * @param[out] clone The cloned location.
+ * @param[in] master The master location.
  *
- *  @see rtems_filesystem_instance_lock().
+ * @see rtems_filesystem_instance_lock().
  */
 void rtems_filesystem_location_clone(
   rtems_filesystem_location_info_t *clone,




More information about the vc mailing list