Skip to content

feat(cmd): man doc support for ocr on UNIX-like systems - #1187

Open
wu21-web wants to merge 8 commits into
alibaba:mainfrom
wu21-web:mandoc
Open

wu21-web wants to merge 8 commits into
alibaba:mainfrom
wu21-web:mandoc

Conversation

@wu21-web

@wu21-web wu21-web commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Description

feat(cmd): man doc support for ocr on UNIX-like systems

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring (no functional changes)
  • Documentation update
  • CI / Build / Tooling

How Has This Been Tested?

  • make test passes locally
  • Manual testing (describe below)

Checklist

  • My code follows the project's coding style (go fmt, go vet)
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the documentation accordingly (if applicable)
  • I have signed the CLA

Related Issues

N/A

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

✅ OpenCodeReview: Review complete: 0 finding(s) across 3 selected item(s).

@wu21-web

wu21-web commented Sep 5, 2026

Copy link
Copy Markdown
Contributor Author

May I request a review from @Qiyuanqiii , thanks!

@Qiyuanqiii Qiyuanqiii left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The man-page generator itself looks solid, and CI is green. I found two installer issues that should be fixed before merge:

  1. For custom install prefixes, the script tells users to add the section directory (for example "/.local/share/man/man1") to "MANPATH". "MANPATH" should point to the manual hierarchy root ("/.local/share/man"), with "man1/" beneath it.

  2. In the no-sudo fallback, the script tells users that the generated pages are available under "$tmp/man" for manual installation, but "$tmp" is removed by the existing "EXIT" trap as soon as the installer exits. That makes the suggested fallback path unusable.

One small doc suggestion as well: it may be worth clarifying that automatic man-page installation currently applies to "install.sh"; with other installation methods, users can generate the pages manually with "ocr man ".

Once the two installer issues are fixed, I’d be happy to take another look.

@wu21-web
wu21-web requested a review from Qiyuanqiii September 5, 2026 18:52

@Qiyuanqiii Qiyuanqiii left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any remaining issues on my end.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants