Changeset 421fae4 in rtems


Ignore:
Timestamp:
Nov 29, 1999, 3:11:15 PM (22 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
61581a1
Parents:
3dfe0b27
Message:

Removed bad descriptions of mount() and umount(). Added shell of an
accurate description.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/posix_users/io.t

    r3dfe0b27 r421fae4  
    2727@item @code{fdatasync} - Synchronize file in-core data with that on disk
    2828@item @code{mount} - Mount a file system
    29 @item @code{umount} - Unmount file systems
     29@item @code{unmount} - Unmount file systems
    3030@item @code{aio_read} - Asynchronous Read
    3131@item @code{aio_write} - Asynchronous Write
     
    742742@ifset is-C
    743743@example
    744 #include <sys/mount.h>
    745 #include <linux/fs.h>
     744#include <libio.h>
    746745
    747746int mount(
    748   const char   *specialfile,
    749   const char    dir,
    750   const char    filesystemtype,
    751   unsigned long rwflag,
    752   const void    data
    753 );
    754 @end example
    755 @end ifset
    756 
    757 @ifset is-Ada
    758 @end ifset
    759 
    760 @subheading STATUS CODES:
    761 
    762 @table @b
    763 @item EPERM
    764 The user is not the super-user.
    765 
    766 @item ENODEV
    767 @code{filesystemtype} not configured in the kernel.
    768 
    769 @item ENOTBLK
    770 @code{specialfile} is not a block device (if a device was required).
    771 
    772 @item EBUSY
    773 @code{specialfile} is already mounted. Or, it cannot be remounted
    774 read-only, because it still holds files open for writing. Or, it
    775 cannot be mounted on @code{dir} because @code{dir} is still busy
    776 (it is the working directory of some task, the mount point of another
    777 device, has open files, etc.).
    778 
    779 @item EINVAL
    780 @code{specialfile} had an invalid superblock. Or, a remount was
    781 attempted, while @code{specialfile} was not already mounted on @code{dir}.
    782 Or, an umount was attempted, while @code{dir} was not a mount point.
    783 
    784 @item EFAULT
    785 One of the pointer arguments points outside the user address space.
    786 
    787 @item ENOMEM
    788 The kernel could not allocate a free page to copy filenames or data into.
    789 
    790 @item ENAMETOOLONG
    791 A pathname was longer than MAXPATHLEN.
    792 
    793 @item ENOTDIR
    794 A pathname was empty or had a nonexistent component.
    795 
    796 @item EACCES
    797 A component of a path was not searchable. Or, mounting a read-only
    798 filesystem was attempted without giving the MS_RDONLY flag. Or, the
    799 block device @code{specialfile} is located on a filesystem mounted with
    800 the MS_NODEV option.
    801 
    802 @item ENXIO
    803 The major number of the block device @code{specialfile} is out of
    804 range.
    805 
    806 @item EMFILE
    807 (In case no block device is required:) Table of dummy devices is full.
    808 
    809 @end table
    810 
    811 @subheading DESCRIPTION:
    812 
    813 @code{Mount} attaches the filesystem specified by @code{specialfile}
    814 (which is often a device name) to the directory specified by @code{dir}.
    815 
    816 Only the super-user may mount filesystems.
    817 
    818 The @code{filesystemtype} argument may take one of the values listed in
    819 /proc/filesystems (link "minix", "ext2", "msdos", "proc", "nfs",
    820 "iso9660" etc.).
    821 
    822 The @code{rwflag} argument has the magic number 0xCOED in the top 16 bits,
    823 and various mount flags in the low order 16 bits. If the magic number is
    824 absent, then the last two arguments are not used.
    825 
    826 The @code{data} argument is interpreted by the different file systems.
     747  rtems_filesystem_mount_table_entry_t **mt_entry,
     748  rtems_filesystem_operations_table    *fs_ops,
     749  rtems_filesystem_options_t            fsoptions,
     750  char                                 *device,
     751  char                                 *mount_point
     752);
     753@end example
     754@end ifset
     755
     756@ifset is-Ada
     757@end ifset
     758
     759@subheading STATUS CODES:
     760
     761@table @b
     762@item EXXX
     763
     764@end table
     765
     766@subheading DESCRIPTION:
     767
     768The @code{mount} routines mounts the filesystem class
     769which uses the filesystem operations specified by @code{fs_ops}
     770and @code{fsoptions}.  The filesystem is mounted at the directory
     771@code{mount_point} and the mode of the mounted filesystem is
     772specified by @code{fsoptions}.  If this filesystem class requires
     773a device, then the name of the device must be specified by @code{device}.
     774
     775If this operation succeeds, the mount table entry for the mounted
     776filesystem is returned in @code{mt_entry}.
    827777
    828778@subheading NOTES:
     
    834784@c
    835785@page
    836 @subsection umount - Umount file systems
    837 
    838 @findex umount
    839 @cindex  umount file systems
    840 
    841 @subheading CALLING SEQUENCE:
    842 
    843 @ifset is-C
    844 @example
    845 #include <sys/mount.h>
    846 #include <linux/fs.h>
    847 
    848 int umount(
    849   const char *specialfile
    850 );
    851 @end example
    852 @end ifset
    853 
    854 @ifset is-Ada
    855 @end ifset
    856 
    857 @subheading STATUS CODES:
    858 
    859 @table @b
    860 @item EPERM
    861 The user is not the super-user.
    862 
    863 @item ENODEV
    864 @code{Filesystemtype} not configured in the kernel.
    865 
    866 @item ENOTBLK
    867 @code{Specialfile} is not a block device (if a device was required).
    868 
    869 @item EBUSY
    870 @code{Specialfile} is already mounted. Or, it cannot be remounted
    871 read-only, because it still holds files open for writing. Or, it
    872 cannot be mounted on @code{dir} because @code{dir} is still busy
    873 (it is the working directory of some task, the mount point of another
    874 device, has open files, etc.).
    875 
    876 @item EINVAL
    877 @code{specialfile} had an invalid superblock. Or, a remount was
    878 attempted, while @code{specialfile} was not already mounted on @code{dir}.
    879 Or, an umount was attempted, while @code{dir} was not a mount point.
    880 
    881 @item EFAULT
    882 One of the pointer arguments points outside the user address space.
    883 
    884 @item ENOMEM
    885 The kernel could not allocate a free page to copy filenames or data into.
    886 
    887 @item ENAMETOOLONG
    888 A pathname was longer than MAXPATHLEN.
    889 
    890 @item ENOTDIR
    891 A pathname was empty or had a nonexistent component.
    892 
    893 @item EACCES
    894 A component of a path was not searchable. Or, mounting a read-only
    895 filesystem was attempted without giving the MS_RDONLY flag. Or, the
    896 block device @code{specialfile} is located on a filesystem mounted with
    897 the MS_NODEV option.
    898 
    899 @item ENXIO
    900 The major number of the block device @code{specialfile} is out of
    901 range.
    902 
    903 @item EMFILE
    904 (In case no block device is required:) Table of dummy devices is full.
    905 
    906 @end table
    907 
    908 @subheading DESCRIPTION:
    909 
    910 @code{Umount} removes the attachment of the filesystem specified
    911 by @code{specialfile} or @code{dir}.
    912 
    913 Only the super-user may umount filesystems.
     786@subsection unmount - Unmount file systems
     787
     788@findex unmount
     789@cindex  unmount file systems
     790
     791@subheading CALLING SEQUENCE:
     792
     793@ifset is-C
     794@example
     795#include <libio.h>
     796
     797int unmount(
     798  const char *mount_path
     799);
     800@end example
     801@end ifset
     802
     803@ifset is-Ada
     804@end ifset
     805
     806@subheading STATUS CODES:
     807
     808@table @b
     809@item EXXX
     810
     811@subheading DESCRIPTION:
     812
     813The @code{unmount} routine removes the attachment of the filesystem specified
     814by @code{mount_path}.
    914815
    915816@subheading NOTES:
Note: See TracChangeset for help on using the changeset viewer.