Changeset 816a9cad in rtems


Ignore:
Timestamp:
Oct 15, 2013, 7:10:38 AM (6 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
e4ced53
Parents:
3c2bb22
Message:

Filesystem: PR2146: Documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libcsupport/include/rtems/libio.h

    r3c2bb22 r816a9cad  
    15351535
    15361536/**
    1537  * @brief Unmounts the file system at @a mount_path.
     1537 * @brief Unmounts the file system instance at the specified mount path.
    15381538 *
    15391539 * The function waits for the unmount process completion.  In case the calling
     
    15491549 * unpredictable effects.
    15501550 *
     1551 * @param[in] mount_path The path to the file system instance mount point.
     1552 *
    15511553 * @retval 0 Successful operation.
    15521554 * @retval -1 An error occurred.  The @c errno indicates the error.
     
    15591561
    15601562/**
    1561  * @brief Mounts a file system at @a target.
    1562  *
    1563  * The @a source may be a path to the corresponding device file, or @c NULL.
    1564  * The @a target path must lead to an existing directory, or @c NULL.
    1565  * In case @a target is @c NULL, the root file system will be mounted.
    1566  * The @a data parameter will be forwarded to the file system
    1567  * initialization handler.  The file system type is selected by
    1568  * @a filesystemtype and may be one of
     1563 * @brief Mounts a file system instance at the specified target path.
     1564 *
     1565 * To mount a standard file system instance one of the following defines should
     1566 * be used to select the file system type
    15691567 * - RTEMS_FILESYSTEM_TYPE_DEVFS,
    15701568 * - RTEMS_FILESYSTEM_TYPE_DOSFS,
     
    15761574 * - RTEMS_FILESYSTEM_TYPE_TFTPFS.
    15771575 *
    1578  * Only configured or registered file system types are available.
    1579  * You can add file system types to your application configuration with
     1576 * Only configured or registered file system types are available.  You can add
     1577 * file system types to your application configuration with the following
     1578 * configuration options
    15801579 * - CONFIGURE_FILESYSTEM_DEVFS,
    15811580 * - CONFIGURE_FILESYSTEM_DOSFS,
     
    15871586 * - CONFIGURE_FILESYSTEM_TFTPFS.
    15881587 *
    1589  * @see rtems_filesystem_register() and mount_and_make_target_path().
     1588 * In addition to these configuration options file system types can be
     1589 * registered with rtems_filesystem_register().
     1590 *
     1591 * @param[in] source The source parameter will be forwarded to the file system
     1592 * initialization handler.  Usually the source is a path to the corresponding
     1593 * device file, or @c NULL.
     1594 * @param[in] target The target path must lead to an existing directory, or
     1595 * must be @c NULL.  In case the target is @c NULL, the root file system will
     1596 * be mounted.
     1597 * @param[in] filesystemtype This string selects the file system type.
     1598 * @param[in] options The options specify if the file system instance allows
     1599 * read-write or read-only access.
     1600 * @param[in] data The data parameter will be forwarded to the file system
     1601 * initialization handler.  It can be used to pass file system specific mount
     1602 * options.  The data structure for mount options is file system specific.  See
     1603 * also in the corresponding file system documentation.
    15901604 *
    15911605 * @retval 0 Successful operation.
    15921606 * @retval -1 An error occurred.  The @c errno indicates the error.
     1607 *
     1608 * @see rtems_filesystem_register(), mount_and_make_target_path(), @ref DOSFS
     1609 * and @ref JFFS2.
    15931610 */
    15941611int mount(
Note: See TracChangeset for help on using the changeset viewer.