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

ship OILS-ERR or -HINT list in (separate?) tarball, and let oils binary use it if available #2095

Open
bar-g opened this issue Oct 19, 2024 · 2 comments

Comments

@bar-g
Copy link
Contributor

bar-g commented Oct 19, 2024

Hi, there, I'm kind of sorry to notice that in the sporadic way I was using osh/oils, my experience of nice and well helping error messages seems to have degraded... For months I haven't installed oils on any machine for improved error messages, mostly installing shellcheck, avoiding to get presented some OILS-ERR-??? quest.

If the error list could be in the tarball [edit: or a separate *-help tarball}, or the tarball compiles a [edit: or could optionally download a separate} lookup file, distro packagers could still create separate oils-for-unix-core or oils-for-unix-doc packages from it (depending on the distro's conventions).

The oils binary could just always look for the file and print out the OILS-ERR text (instead of just a number), if the file is installed?

@andychu
Copy link
Contributor

andychu commented Oct 20, 2024

In the latest release, you can do help OILS-ERR-100 and it prints a URL

I don't think we can include the text, just for reasons of size -- similarly we don't include all help topics, just the URLs

@bar-g
Copy link
Contributor Author

bar-g commented Oct 20, 2024

Hm, how large is the error text file?

Hm, I guess distro packagers would usually similarly put the help topics into a *-doc or *-full package, or would not include them in their *-core package (depending on how distros organize their packages).

But ok, if you want to keep the current default tarball download small, then maybe just let the build scripts look for the local presence of the error and help topics? (Allow users to optionally download a separate *-help tarball?)

@bar-g bar-g changed the title include OILS-ERR list in tarball, and let ysh binary use it if available include OILS-ERR list in (separate?) tarball, and let ysh binary use it if available Oct 20, 2024
@bar-g bar-g changed the title include OILS-ERR list in (separate?) tarball, and let ysh binary use it if available ship OILS-ERR list in (separate?) tarball, and let ysh binary use it if available Oct 20, 2024
@bar-g bar-g changed the title ship OILS-ERR list in (separate?) tarball, and let ysh binary use it if available ship OILS-ERR list in (separate?) tarball, and let oils binary use it if available Oct 21, 2024
@bar-g bar-g changed the title ship OILS-ERR list in (separate?) tarball, and let oils binary use it if available ship OILS-ERR or -HINT list in (separate?) tarball, and let oils binary use it if available Oct 23, 2024
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

No branches or pull requests

2 participants