From 816a9cad30acfef9200c47efd4333e658606d7ee Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 15 Oct 2013 09:10:38 +0200 Subject: Filesystem: PR2146: Documentation --- cpukit/libcsupport/include/rtems/libio.h | 39 +++++++++++++++++++++++--------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h index f3a918169a..8eda539948 100644 --- a/cpukit/libcsupport/include/rtems/libio.h +++ b/cpukit/libcsupport/include/rtems/libio.h @@ -1534,7 +1534,7 @@ int rtems_filesystem_unregister( ); /** - * @brief Unmounts the file system at @a mount_path. + * @brief Unmounts the file system instance at the specified mount path. * * The function waits for the unmount process completion. In case the calling * thread uses resources of the unmounted file system the function may never @@ -1548,6 +1548,8 @@ int rtems_filesystem_unregister( * A concurrent unmount request for the same file system instance has * unpredictable effects. * + * @param[in] mount_path The path to the file system instance mount point. + * * @retval 0 Successful operation. * @retval -1 An error occurred. The @c errno indicates the error. * @@ -1558,14 +1560,10 @@ int unmount( ); /** - * @brief Mounts a file system at @a target. + * @brief Mounts a file system instance at the specified target path. * - * 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 + * To mount a standard file system instance one of the following defines should + * be used to select the file system type * - RTEMS_FILESYSTEM_TYPE_DEVFS, * - RTEMS_FILESYSTEM_TYPE_DOSFS, * - RTEMS_FILESYSTEM_TYPE_FTPFS, @@ -1575,8 +1573,9 @@ int unmount( * - 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 + * Only configured or registered file system types are available. You can add + * file system types to your application configuration with the following + * configuration options * - CONFIGURE_FILESYSTEM_DEVFS, * - CONFIGURE_FILESYSTEM_DOSFS, * - CONFIGURE_FILESYSTEM_FTPFS, @@ -1586,10 +1585,28 @@ int unmount( * - CONFIGURE_FILESYSTEM_RFS, and * - CONFIGURE_FILESYSTEM_TFTPFS. * - * @see rtems_filesystem_register() and mount_and_make_target_path(). + * In addition to these configuration options file system types can be + * registered with rtems_filesystem_register(). + * + * @param[in] source The source parameter will be forwarded to the file system + * initialization handler. Usually the source is a path to the corresponding + * device file, or @c NULL. + * @param[in] target The target path must lead to an existing directory, or + * must be @c NULL. In case the target is @c NULL, the root file system will + * be mounted. + * @param[in] filesystemtype This string selects the file system type. + * @param[in] options The options specify if the file system instance allows + * read-write or read-only access. + * @param[in] data The data parameter will be forwarded to the file system + * initialization handler. It can be used to pass file system specific mount + * options. The data structure for mount options is file system specific. See + * also in the corresponding file system documentation. * * @retval 0 Successful operation. * @retval -1 An error occurred. The @c errno indicates the error. + * + * @see rtems_filesystem_register(), mount_and_make_target_path(), @ref DOSFS + * and @ref JFFS2. */ int mount( const char *source, -- cgit v1.2.3