CismonX
5286cda051
doc: update backend API
...
- Add doc for the `bookmark_list` function.
- Other misc changes.
2025-02-01 19:07:42 +08:00
CismonX
93ff8cabe9
doc: update backend API
...
Add doc for the `backend_mkfs` function.
2025-01-31 00:09:17 +08:00
CismonX
6cae25ee7f
doc: misc update
2025-01-30 21:50:56 +08:00
CismonX
da453cdefd
doc: update backend API
...
Add doc for the `backend_sandbox` function.
2025-01-29 23:10:22 +08:00
CismonX
341b7b3d5a
doc: misc update
...
- Add manual section for the utility library.
- Add comments for utility library functions.
- Fix installation path for backends and fsck handlers.
2025-01-28 20:56:06 +08:00
CismonX
56fa90397d
fs_ops: limit xattr value length
2025-01-27 23:48:37 +08:00
CismonX
18b801f960
doc: update backend API
...
Add doc for the `bookmark_lookup` function.
2025-01-27 23:19:28 +08:00
CismonX
579f396e46
doc: minor update
2025-01-26 19:39:13 +08:00
CismonX
3ed11f53e5
backend: fix xattr bookmark title check
...
Do not check if the bookmark title is a valid filename,
as we said in the user manual.
However, we should ensure that the string does not contain
NUL characters, since we assume that a valid bookmark storage
should not contain bookmarks with such names.
2025-01-26 19:35:03 +08:00
CismonX
10ad224b03
backend: rename backend_sync -> bookmark_sync
2025-01-24 23:07:22 +08:00
CismonX
bff21c54b1
doc: update doc for fsck handler API
...
Add doc for the `run` function.
2025-01-24 18:37:23 +08:00
CismonX
a01912e6f0
doc: misc update
...
- 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.
2025-01-24 17:18:57 +08:00
CismonX
8e86e56dfc
doc: update backend API and fsck handler API
...
- Add doc for the `backend_destroy` function.
- Add doc for the fsck handler `create` and `destroy` functions.
2025-01-24 09:44:04 +08:00
CismonX
623b4dd4f3
backend: rename backend_free -> backend_destroy
2025-01-24 09:12:41 +08:00
CismonX
3cb99fe85b
all: fix punctuation regarding "e.g." and "i.e."
...
Follow the convention of modern English grammar that
a comma should usually come after "e.g." and "i.e.".
2025-01-23 19:23:54 +08:00
CismonX
5d861f4752
doc: update doc for backend API
...
Add doc for the `backend_create` function.
2025-01-23 19:11:36 +08:00
CismonX
0510e5e8c0
doc: update doc for fsck handler API
...
Add doc for the `info` function.
2025-01-23 18:02:10 +08:00
CismonX
228f1b621e
doc: misc fix
...
- Specify lowercase "c" for @example, otherwise
GNU Source-highlight recognize it as C++ code.
- ...
2025-01-23 17:48:47 +08:00
CismonX
c2bdd02c65
doc: update backend API
...
Add doc for `backend_init` and `backend_info` functions.
2025-01-21 20:15:58 +08:00
CismonX
6989f1e828
doc: misc refactor
2025-01-21 19:24:02 +08:00
CismonX
12fb17463a
doc: add overview for backend and fsck handler API
2025-01-21 11:53:49 +08:00
CismonX
8b1c0d0dc1
doc: misc update
2025-01-20 20:08:06 +08:00
CismonX
712861e8f8
fsck: fix fsck apply
...
- Throw an error if the handler tries to apply in readonly mode
- Do not expose BOOKMARKFS_FSCK_RESULT_END to the handler
2025-01-18 08:52:43 +08:00
CismonX
7aaa8753cc
doc: misc update
...
- Limitations on FreeBSD
- Extended attributes for backends
- ...
2025-01-17 21:52:59 +08:00
CismonX
521fadcc2c
doc: add doc for the Tcl-based fsck handler
2025-01-16 22:19:59 +08:00
CismonX
fb197f9941
doc: fix style
...
Make sure there is a blank line between table items.
This affects Info output.
2025-01-16 12:46:58 +08:00
CismonX
dad6533028
doc: update section "directory entries"
...
Explain why "." and ".." entries are missing from BookmarkFS.
2025-01-16 11:42:42 +08:00
CismonX
76d22c5bcc
doc: misc update
2025-01-14 09:22:26 +08:00
CismonX
7b2942416b
doc: update doc for programs and backends
2025-01-12 23:19:58 +08:00
CismonX
0c65676309
doc: refactor style
...
- Use @samp for string values that are not necessarily code.
- Use @t for integer values.
2025-01-12 18:08:16 +08:00
CismonX
f6fcd489f2
doc: add doc for fsck handlers
2025-01-12 17:06:05 +08:00
CismonX
c1b8267939
doc: add doc for fsck ioctls
2025-01-11 19:04:46 +08:00
CismonX
68281c2ecb
doc: refactor doc for mount.bookmarkfs
...
Explain the `-o ctime` option better.
2025-01-11 02:28:27 +08:00
CismonX
7e54112178
doc: update doc for fsck.bookmarkfs
2025-01-11 02:16:00 +08:00
CismonX
a4878bfe6d
doc: refactor
2025-01-08 22:49:35 +08:00
CismonX
16e454c30c
doc: refactor
2025-01-08 12:57:06 +08:00
CismonX
9960d67465
doc: add doc for the Chromium backend
2025-01-08 11:58:15 +08:00
CismonX
1602853772
doc: add doc for the Firefox backend
2025-01-08 01:12:44 +08:00
CismonX
6978feb9d4
doc: update doc for mount.bookmarkfs
...
Mention about automatically dismounting on signals.
2025-01-08 01:11:56 +08:00
CismonX
47f51435d1
doc: update doc for fsck.bookmarkfs
2025-01-06 20:06:08 +08:00
CismonX
19df7c9323
doc: improve code example rendering
...
Specify the language used in @example, for syntax highlighting
with customization variable HIGHLIGHT_SYNTAX.
Also remove the @varx definition. No need for that any more.
2025-01-06 19:14:18 +08:00
CismonX
4d9f89df44
doc: add doc for mkfs.bookmarkfs and bookmarkctl
2025-01-06 12:42:14 +08:00
CismonX
9a21c84e1c
doc: minor refactor
2025-01-05 19:31:51 +08:00
CismonX
648e0e365f
doc: update manual for mount.bookmarkfs
...
- Add section in texinfo doc
- Wording correction in manpage
2025-01-05 18:39:12 +08:00
CismonX
8742bdc248
doc: proper use of @command and @var
2025-01-05 14:48:05 +08:00
CismonX
f94aee0110
doc: add section "error codes"
2025-01-04 18:13:30 +08:00
CismonX
a322569822
doc: rename titles; fix ellipsis punctuation
2025-01-04 16:52:11 +08:00
CismonX
96746de4bf
doc: add more content to chapter "the filesystem"
2025-01-04 16:18:16 +08:00
CismonX
bd8e512fe5
doc: add "bookmarks" subsection under fs hier.
2025-01-04 00:32:35 +08:00
CismonX
486bd6b36e
doc: add subsection "permute directory entries"
2025-01-02 18:43:31 +08:00