Conversation
docs/manual-pages.md describes man1/ as holding `bm(1)` / `bm-status(1)`, but no such page is bundled: man1/ ships eight shell-command pages and `bm man bm-status` returns "No manual entry". Point the docs at the pages that are actually there. Fixes basicmachines-co#1590 Signed-off-by: Siri <masteragentsiri@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/manual-pages.mddescribesman1/as the section holdingbm(1)andbm-status(1). Neither page is bundled. This points the docs at the pagesthat
man1/actually ships. Docs only, no code touched. Fixes #1590.What I checked at
3bf2d523bm man listisbundled_pages(), which isMAN_DIR.glob("man[1-9]/*.md")(src/basic_memory/man/__init__.py:116). Sothe shipped set is exactly what is on disk:
Eight section-1 pages, 22 section-3 pages, 30 total — all shell commands or
MCP tools. No
bm-status(1), nobm(1).bm man bm-statustherefore takesthe bundled-miss path in
show()and falls through to the manual project,which on a plain install prints:
The groff sources do exist, but not as
man[1-9]/*.mdpages:bm.1andbasic-memory.1sit at theman/root, andbm man installglobs them with
_MAN_SOURCE_DIR.glob("*.1")(
cli/commands/man.py:239) to copy into~/.local/share/man/man1/. Thatis a separate pipeline from
bundled_pages(), which is whyman bmworksafter
bm man installwhilebm man bmdoes not.Question for @phernandez — which fix do you want?
There are two defensible reads of #1590 and they lead to different patches:
(A) The docs are wrong.
man1/was always meant to be the shell-commandsection,
bm(1)/bm-status(1)in that line is leftover text from an earlierplan, and the fix is to describe what ships. That is this PR: 13 lines, no
behaviour change.
(B) The docs are right and the packaging is behind.
bm(1)is supposedto be readable through
bm man, the groff source is already sitting in thetree, and the real gap is that
bundled_pages()only ever looks inman[1-9]/, so a page at theman/root can never surface. Then the fix isto wire
bm.1into the bundled set (or add abm(1).md), andbm-status(1)becomes a page to write rather than a line to delete.
I can't tell from outside which one is intended, because both are consistent
with the current tree — the
man/-root groff files could be deliberatelyinstall-only, or just not wired up yet. The Roadmap section's "Groff for
section 3" item reads like the two pipelines are meant to converge eventually,
which nudges me toward (B) being the long-term intent and (A) being correct
for today. But that's a guess about your plan, not something the code tells
me.
If you want (B), say so and I'll redo this as (B) instead — happy to close
this one.
DCO sign-off is included on the commit. I'll sign the CLA whenever the bot
asks.