Closed Bug 1488089 Opened 7 years ago Closed 7 years ago

Rewrite section on `chg` on mozilla-version-control-tools.readthedocs.io

Categories

(Developer Services :: General, task)

Product:
Developer Services
Component:
General
Type:
task
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: jwatt, Assigned: sheehan)

Details

https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/extensions.html#chg Currently that section lists chg under the section "3rd Party Extensions You Should Highly Consider" and links to the old chg repo. This strongly implies that users should be installing from that repo. In fact chg appears to have been distributed with mercurial for a couple of years now (it's installed when you install mercurial via homebrew, for example). Also the wiki page on chg here: https://www.mercurial-scm.org/wiki/CHg says "Make sure to use the chg executable bundled with the source of the installed hg version". It seems like there should be a suggestion on the readthedocs page to set up the shell alias for chg, but chg shouldn't be mentioned under third party extensions, and it shouldn't like to that old, stale chg repo.
Assignee: nobody → sheehan
Status: NEW → ASSIGNED
Pushed by cosheehan@mozilla.com: https://hg.mozilla.org/hgcustom/version-control-tools/rev/f4c031a8165f docs: update section on `chg`
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
"you will need to [build from source]" isn't necessarily correct. chg comes with hg in homebrew. I'm assuming linux distros and macports are similar. It might be better to remove the mention of building from our docs, and just refer people to the https://www.mercurial-scm.org/wiki/CHg page. Then that page should probably be fixed up separately to mention homebrew, etc.
Flags: needinfo?(sheehan)
Good point, the docs also mention you should "make sure to use the chg executable bundled with the source of the installed hg version". So if users have a version of Mercurial installed through a package manager and they attempt to build locally, they could run into problems. I'll update with your suggestions. :) I also managed to muck up the formatting on the rendered RtD page... d'oh.
Status: RESOLVED → REOPENED
Flags: needinfo?(sheehan)
Resolution: FIXED → ---
Awesome, thank you. :)
Pushed by cosheehan@mozilla.com: https://hg.mozilla.org/hgcustom/version-control-tools/rev/f00f54bc64b9 docs: remove build instructions from `chg` section
Status: REOPENED → RESOLVED
Closed: 7 years ago → 7 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.