Bring the man pages up to date - #517
Open
bbatsov wants to merge 1 commit into
Open
Conversation
The man pages predated the switch to XDG paths (ocaml-community#484) and had accumulated some errors: - utoprc lives in $XDG_CONFIG_HOME/utop/utoprc these days, with ~/.utoprc honored only as a legacy fallback - document the history file and its location - utop-full.1 claimed the binary is called "utop" - mention reason-mode and utop-mode-compat-alist in the Emacs section - note that -safe-string is gone with OCaml >= 5.0 - point to the shipped utoprc-dark/utoprc-light files and sync the example with utoprc-dark - fix a couple of typos (top-kill, \fb)
Member
|
The changes look good to me, I don't understand why the CI failed... |
Contributor
It's doing the same to me on my PR here: #514 With no changes it went from succeeding to randomly failing on various builds. Sometimes if I re-run it it succeeds, other times not. |
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
3 participants
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.
I came across the man pages randomly while looking for the syntax highlighting config and figured the stale bits were worth fixing.
They still documented the pre-XDG paths (
~/.utoprc), even though the config moved to$XDG_CONFIG_HOME/utop/utoprcin #484. I've updated utop(1) and utoprc(5) to document the current locations (noting the legacy fallbacks still work), added the previously undocumented history file to FILES, and pointed to the shipped utoprc-dark/utoprc-light configs.Along the way I also fixed a few small errors: utop-full(1) claimed the binary is called
utop,-safe-stringno longer exists on OCaml >= 5.0, the Emacs section was missing reason-mode andutop-mode-compat-alist, plus a couple of typos.