Environment
- basic-memory
0.23.2 (main @ 3bf2d523)
- Python 3.14.3, CentOS Linux 8
Summary
docs/manual-pages.md documents man1/ as holding bm CLI command pages and
uses bm-status(1) as its worked example in two places. No such page is
bundled, and no man1/ page documents a bm subcommand at all — the section
ships eight pages named after the note/shell-analog tools (ls, cat,
grep, ...). A reader following the docs asks for bm-status(1) and gets a miss.
Steps to reproduce
bm man list
bm man bm-status
ls src/basic_memory/man/man1/
Actual output
bm man list — every section-1 page:
apropos(1) cat(1) find(1) grep(1) head(1) ls(1) tail(1) tree(1)
bm man bm-status:
No manual entry for bm-status (try: bm man list)
ls src/basic_memory/man/man1/ confirms the same eight files; bm-status(1).md
is not among them.
Expected
Either the page exists, or the docs name a page that does. Two doc lines assert
it does:
docs/manual-pages.md:27 — ├── man1/ # CLI commands bm(1), bm-status(1), ...
docs/manual-pages.md:58 — ``- man1/ — bm CLI commands → `bm-status(1)```
bm(1) is likewise absent from the bundled corpus.
Notes
Section 1 is described as "user commands (ls, grep)" at
docs/manual-pages.md:41, and the bundled pages do match that Unix reading —
so the pages may be right and only the two bm-status(1) references wrong.
The mismatch is narrower than it looks: find_page
(src/basic_memory/man/__init__.py) resolves correctly for everything that
is shipped; I checked search-notes(3), search-notes.3, search-notes-3,
3/search-notes, man3/search-notes, search_notes and
man3/search-notes(3).md all resolve to search-notes(3). Only the
documented-but-absent names miss.
Possible fix
Cheapest: update docs/manual-pages.md:27 and :58 to use a page that ships
(e.g. ls(1)), matching the section-1 definition already given at line 41.
If man1/ is instead meant to cover bm subcommands, the two lines are
correct and the pages are the gap — worth saying which, since
src/basic_memory/man/ already ships basic-memory.1 and bm.1 groff
sources (at the man/ root, not under man1/) that bm man list does not
surface.
Happy to send a PR for the docs-only fix if that is the intended direction.
Environment
0.23.2(main@3bf2d523)Summary
docs/manual-pages.mddocumentsman1/as holdingbmCLI command pages anduses
bm-status(1)as its worked example in two places. No such page isbundled, and no
man1/page documents abmsubcommand at all — the sectionships eight pages named after the note/shell-analog tools (
ls,cat,grep, ...). A reader following the docs asks forbm-status(1)and gets a miss.Steps to reproduce
Actual output
bm man list— every section-1 page:bm man bm-status:ls src/basic_memory/man/man1/confirms the same eight files;bm-status(1).mdis not among them.
Expected
Either the page exists, or the docs name a page that does. Two doc lines assert
it does:
docs/manual-pages.md:27—├── man1/ # CLI commands bm(1), bm-status(1), ...docs/manual-pages.md:58— ``- man1/ —bmCLI commands → `bm-status(1)```bm(1)is likewise absent from the bundled corpus.Notes
Section 1 is described as "user commands (
ls,grep)" atdocs/manual-pages.md:41, and the bundled pages do match that Unix reading —so the pages may be right and only the two
bm-status(1)references wrong.The mismatch is narrower than it looks:
find_page(
src/basic_memory/man/__init__.py) resolves correctly for everything thatis shipped; I checked
search-notes(3),search-notes.3,search-notes-3,3/search-notes,man3/search-notes,search_notesandman3/search-notes(3).mdall resolve tosearch-notes(3). Only thedocumented-but-absent names miss.
Possible fix
Cheapest: update
docs/manual-pages.md:27and:58to use a page that ships(e.g.
ls(1)), matching the section-1 definition already given at line 41.If
man1/is instead meant to coverbmsubcommands, the two lines arecorrect and the pages are the gap — worth saying which, since
src/basic_memory/man/already shipsbasic-memory.1andbm.1groffsources (at the
man/root, not underman1/) thatbm man listdoes notsurface.
Happy to send a PR for the docs-only fix if that is the intended direction.