Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggesting trying tlmgr-info for packages without any document #55

Open
wtsnjp opened this issue Mar 8, 2020 · 2 comments
Open

Suggesting trying tlmgr-info for packages without any document #55

wtsnjp opened this issue Mar 8, 2020 · 2 comments
Labels
change Changing program's behavior enhancement New feature or request search Searching

Comments

@wtsnjp
Copy link
Member

wtsnjp commented Mar 8, 2020

Currently, for package names without any document, Texdoc automatically executes the fuzzy search and delivers the results. For instance, with a query "genmisc":

$ texdoc -v genmisc
texdoc info: Fuzzy search result: mentis
texdoc info: View command: open "/usr/local/texlive/2019/texmf-dist/doc/latex/mentis/mentis.pdf"
texdoc info: Setting environment LC_CTYPE to: en_US.UTF-8

However, a package named "genmisc" actually exists in TeX Live. IMO, in case that a package exactly matches to a query exists in TeX Live, it is better to say something like

$ texdoc <kw>
Package <kw> exists, but unfortunately no documentaiton found.
Try `tlmgr info <kw>` for some information about the package.

than silently performing the fuzzy search and deriver results for another package found with the feature.

At this point, the cache files generated by the database texlive.tlpdb does not include any information about packages without any document. This means Texdoc can't recognize the names of such packages. To implement this enhancement, such names also need to be included in the cache files.

@wtsnjp wtsnjp added the enhancement New feature or request label Mar 8, 2020
@kberry
Copy link
Contributor

kberry commented Mar 8, 2020

I certainly agree with you that a diagnostic is better than silently doing the fuzzy search in this case.

By the by, I hope to get rid of genmisc at some future point, but don't hold your breath ...

@kberry
Copy link
Contributor

kberry commented Mar 12, 2020

Not that it matters for the general issue, but FYI, I just finished splitting genmisc into its component (mostly single file) packages and deleted genmisc itself. There are plenty of other packages that only exist in TL for testing, though, e.g., afm2pl.

@wtsnjp wtsnjp added change Changing program's behavior search Searching labels Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change Changing program's behavior enhancement New feature or request search Searching
Projects
None yet
Development

No branches or pull requests

2 participants