makary/bookmarkfs
1
0
Fork 0
mirror of https://git.sr.ht/~cismonx/bookmarkfs synced 2025-06-07 19:58:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: misc update

Browse source 
- Remove bogus EACCES for BOOKMARKFS_IOC_FSCK_NEXT.
  If read permission is denied, the directory fd would not have
  been obtained from open() in the first place.
- Add description for pkglibdir.
This commit is contained in:
CismonX 2025-01-24 17:18:57 +08:00
parent 8e86e56dfc
commit a01912e6f0
No known key found for this signature in database
GPG key ID: 3094873E29A482FB
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/bookmarkfs.texi
View file

@ -971,7 +971,7 @@ int ioctl (int dirfd, BOOKMARKFS_IOC_FSCK_NEXT,
struct bookmarkfs_fsck_data *argp); struct bookmarkfs_fsck_data *argp);
int ioctl (int dirfd, BOOKMARKFS_IOC_FSCK_APPLY, int ioctl (int dirfd, BOOKMARKFS_IOC_FSCK_APPLY,
struct bookmarkfs_fsck_data *argp) struct bookmarkfs_fsck_data *argp);
int ioctl (int dirfd, BOOKMARKFS_IOC_FSCK_REWIND); int ioctl (int dirfd, BOOKMARKFS_IOC_FSCK_REWIND);
@end example @end example
@ -1028,12 +1028,7 @@ The bookmark name is either @samp{.} or @samp{..}.
Value of @code{extra} is unspecified. Value of @code{extra} is unspecified.
@end table @end table
On failure, @code{ioctl()} returns @t{-1}, and sets @code{errno}: On failure, @code{ioctl()} returns @t{-1}, and sets @code{errno}.
@table @code
@item EACCES
Read permission is denied for the directory.
@end table
@item BOOKMARKFS_IOC_FSCK_APPLY @item BOOKMARKFS_IOC_FSCK_APPLY
``Repair'' a bookmark by renaming it. ``Repair'' a bookmark by renaming it.
@ -1109,6 +1104,10 @@ Typically, backends are built into shared libraries, and are installed as:
@end example @end example
@table @var @table @var
@item $@{pkglibdir@}
Presumably @file{@var{$@{prefix@}}/lib/bookmarkfs}.
@xref{Uniform,, The Uniform Naming Scheme, automake, GNU Automake}.
@item $@{name@} @item $@{name@}
The backend name, equivalent to the value given to the The backend name, equivalent to the value given to the
@option{-o backend=@var{name}} option of frontend programs. @option{-o backend=@var{name}} option of frontend programs.
@ -1753,6 +1752,10 @@ shared libraries, and are installed as:
@end example @end example
@table @var @table @var
@item $@{pkglibdir@}
Presumably @file{@var{$@{prefix@}}/lib/bookmarkfs}.
@xref{Uniform,, The Uniform Naming Scheme, automake, GNU Automake}.
@item $@{name@} @item $@{name@}
The handler name, equivalent to the value given to the The handler name, equivalent to the value given to the
@option{-o handler=@var{name}} option of @command{fsck.bookmarkfs}. @option{-o handler=@var{name}} option of @command{fsck.bookmarkfs}.