Commit graph

94 commits

Author SHA1 Message Date
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
CismonX
3d56aa560f
doc: make examples more intuitive 2025-01-02 17:06:51 +08:00
CismonX
babeca2dcd
doc: rewrite examples for extended attributes 2025-01-02 16:53:57 +08:00
CismonX
e06a4d55bc
doc: add a newline to the end of each sentence
We don't want the git diff to span the entire paragraph when
only one line is changed.

Also makes the doc more readable in plaintext.
2025-01-02 00:43:27 +08:00
CismonX
0863343749
doc: filesystem hierarchy 2025-01-01 23:58:03 +08:00
CismonX
cdf0ddfc53
init: prepare for Savannah 2024-12-31 18:09:03 +08:00