Changeset cde999a in mainline for uspace/lib/c/generic/vfs/vfs.c


Ignore:
Timestamp:
2018-01-04T20:22:51Z (7 years ago)
Author:
Jiří Zárevúcky <zarevucky.jiri@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
3d95c9d, 84a1a54
Parents:
3c7702c0
git-author:
Jiří Zárevúcky <zarevucky.jiri@…> (2018-01-04 19:18:29)
git-committer:
Jiří Zárevúcky <zarevucky.jiri@…> (2018-01-04 20:22:51)
Message:

Fix comments to stop referring to error codes as negative.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/c/generic/vfs/vfs.c

    r3c7702c0 rcde999a  
    236236 *                      handle will be allocated from high indices
    237237 *
    238  * @return              New file handle on success or a negative error code
     238 * @return              New file handle on success or an error code
    239239 */
    240240int vfs_clone(int file_from, int file_to, bool high, int *handle)
    … …  
    259259 * @param size          Size of @a buf
    260260 *
    261  * @return              EOK on success or a non-negative error code
     261 * @return              EOK on success or a non-error code
    262262 */
    263263int vfs_cwd_get(char *buf, size_t size)
    … …  
    280280 * @param path  Path of the new working directory
    281281 *
    282  * @return      EOK on success or a negative error code
     282 * @return      EOK on success or an error code
    283283 */
    284284int vfs_cwd_set(const char *path)
    … …  
    370370 * @param info    Place to store volume identification information
    371371 *
    372  * @return                      EOK on success or a negative error code
     372 * @return                      EOK on success or an error code
    373373 */
    374374int vfs_fsprobe(const char *fs_name, service_id_t serv,
    … …  
    404404 *        fstypes->fstypes[0..]. To free the list use vfs_fstypes_free().
    405405 *
    406  * @return                      EOK on success or a negative error code
     406 * @return                      EOK on success or an error code
    407407 */
    408408int vfs_fstypes(vfs_fstypes_t *fstypes)
    … …  
    499499 * @param[out] linkedfd If not NULL, will receive a file handle to the linked
    500500 *                      child
    501  * @return              EOK on success or a negative error code
     501 * @return              EOK on success or an error code
    502502 */
    503503int vfs_link(int parent, const char *child, vfs_file_kind_t kind, int *linkedfd)
    … …  
    529529 * @param[out] linkedfd If not NULL, will receive a file handle to the linked
    530530 *                      child
    531  * @return              EOK on success or a negative error code
     531 * @return              EOK on success or an error code
    532532 */
    533533int vfs_link_path(const char *path, vfs_file_kind_t kind, int *linkedfd)
    … …  
    585585 * @param[out] handle Pointer to variable where handle is to be written.
    586586 *
    587  * @return      EOK on success or a negative error code
     587 * @return      EOK on success or an error code
    588588 */
    589589int vfs_lookup_open(const char *path, int flags, int mode, int *handle)
    … …  
    614614 * @param[out] mountedfd        File handle of the mounted root if not NULL
    615615 *
    616  * @return                      EOK on success or a negative error code
     616 * @return                      EOK on success or an error code
    617617 */
    618618int vfs_mount(int mp, const char *fs_name, service_id_t serv, const char *opts,
    … …  
    658658 * @param[in] instance          Instance number of the file system server
    659659 *
    660  * @return                      EOK on success or a negative error code
     660 * @return                      EOK on success or an error code
    661661 */
    662662int vfs_mount_path(const char *mp, const char *fs_name, const char *fqsn,
    … …  
    752752 * @param mode  Mode in which to open file in
    753753 *
    754  * @return      EOK on success or a negative error code
     754 * @return      EOK on success or an error code
    755755 */
    756756int vfs_open(int file, int mode)
    … …  
    769769 * @param exch          Exchange to the acceptor
    770770 *
    771  * @return              EOK on success or a negative error code
     771 * @return              EOK on success or an error code
    772772 */
    773773int vfs_pass_handle(async_exch_t *vfs_exch, int file, async_exch_t *exch)
    … …  
    781781 * @param file  File handle to put
    782782 *
    783  * @return      EOK on success or a negative error code
     783 * @return      EOK on success or an error code
    784784 */
    785785int vfs_put(int file)
    … …  
    798798 * @param[out] handle  Received handle.
    799799 *
    800  * @return       EOK on success or a negative error code
     800 * @return       EOK on success or an error code
    801801 */
    802802int vfs_receive_handle(bool high, int *handle)
    … …  
    877877 * @param[out] nread    Actual number of bytes read (0 or more)
    878878 *
    879  * @return              EOK on success or a negative error code
     879 * @return              EOK on success or an error code
    880880 */
    881881int vfs_read_short(int file, aoff64_t pos, void *buf, size_t nbyte,
    … …  
    919919 * @param new   New path
    920920 *
    921  * @return      EOK on success or a negative error code
     921 * @return      EOK on success or an error code
    922922 */
    923923int vfs_rename_path(const char *old, const char *new)
    … …  
    986986 * @param length        New length
    987987 *
    988  * @return              EOK on success or a negative error code
     988 * @return              EOK on success or an error code
    989989 */
    990990int vfs_resize(int file, aoff64_t length)
    … …  
    10501050 * @param[out] stat     Place to store file information
    10511051 *
    1052  * @return              EOK on success or a negative error code
     1052 * @return              EOK on success or an error code
    10531053 */
    10541054int vfs_stat(int file, struct stat *stat)
    … …  
    10841084 * @param[out] stat     Place to store file information
    10851085 *
    1086  * @return              EOK on success or a negative error code
     1086 * @return              EOK on success or an error code
    10871087 */
    10881088int vfs_stat_path(const char *path, struct stat *stat)
    … …  
    11051105 * @param[out] st       Buffer for storing information
    11061106 *
    1107  * @return              EOK on success or a negative error code
     1107 * @return              EOK on success or an error code
    11081108 */
    11091109int vfs_statfs(int file, struct statfs *st)
    … …  
    11301130 * @param[out] st       Buffer for storing information
    11311131 *
    1132  * @return              EOK on success or a negative error code
     1132 * @return              EOK on success or an error code
    11331133 */
    11341134int vfs_statfs_path(const char *path, struct statfs *st)
    … …  
    11501150 * @param file  File handle to synchronize
    11511151 *
    1152  * @return      EOK on success or a negative error code
     1152 * @return      EOK on success or an error code
    11531153 */
    11541154int vfs_sync(int file)
    … …  
    11721172 * @param expect        File handle of the unlinked child
    11731173 *
    1174  * @return              EOK on success or a negative error code
     1174 * @return              EOK on success or an error code
    11751175 */
    11761176int vfs_unlink(int parent, const char *child, int expect)
    … …  
    12011201 * @param path          Old path to be unlinked
    12021202 *
    1203  * @return              EOK on success or a negative error code
     1203 * @return              EOK on success or an error code
    12041204 */
    12051205int vfs_unlink_path(const char *path)
    … …  
    12301230 * @param mp    File handle representing the mount-point
    12311231 *
    1232  * @return      EOK on success or a negative error code
     1232 * @return      EOK on success or an error code
    12331233 */
    12341234int vfs_unmount(int mp)
    … …  
    12441244 * @param mpp   Mount-point path
    12451245 *
    1246  * @return      EOK on success or a negative error code
     1246 * @return      EOK on success or an error code
    12471247 */
    12481248int vfs_unmount_path(const char *mpp)
    … …  
    13411341 * @param[out] nread    Actual number of bytes written (0 or more)
    13421342 *
    1343  * @return              EOK on success or a negative error code
     1343 * @return              EOK on success or an error code
    13441344 */
    13451345int vfs_write_short(int file, aoff64_t pos, const void *buf, size_t nbyte,
Note: See TracChangeset for help on using the changeset viewer.