980295 - Fix documentation for hgrc [extension] paths for Windows

Status: RESOLVED FIXED

(Developer Services :: Mercurial: hg.mozilla.org, defect)

Description

[Ed Morley [:emorley]]

On Unix based filesystems, any of the following will work in an hgrc:

[extensions]
bar = /foo/bar
baz = /foo/baz/

However on Windows, the second case in this example will fail, due to the trailing slash:

[extensions]
bar = c:\foo\bar
baz = c:\foo\baz\

I've reported & fixed this bug upstream (http://bz.selenic.com/show_bug.cgi?id=4187), however we should fix documentation that lists the trailing slash case, to avoid confusing new contributors using Mercurial 1.9.1 or earlier.

(I should add that it's for this reason that for years my hgrc contains direct references to the .py files in the paths rather than the directories, due to me trying things randomly when the various hg extension README instructions didn't work, which caused things to break post some of the deps of bug 968958).

Comment 1

[Ed Morley [:emorley]]

Searched wiki.m.o, MDN and various hg extension repos for mentions of '[extensions]' and that are not just listing native mercurial extensions with no path. Found...

Already ok:
https://developer.mozilla.org/en-US/docs/Installing_Mercurial
https://wiki.mozilla.org/Sfink/Mercurial
https://wiki.mozilla.org/User:Armenzg:set_my_environment_up
https://bitbucket.org/sfink/mqext/src/fe7ca4826e6eabe4449d62f09f1af9a09d50e834/README.txt?at=default
https://github.com/pbiggar/trychooser/blob/master/README.md
https://hg.mozilla.org/hgcustom/pushlog/file/0ffe19e2e343/README
https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/hgext/mozext/README

Changed now:
https://developer.mozilla.org/en-US/docs/Developer_Guide/Landing_a_patch

Needs fixing:
https://bitbucket.org/sfink/trychooser/src/beed16e594800e2e0af4171d876d6c93390a2099/README.md?at=default
https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/hgext/bzexport/README
https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/hgext/qbackout/README
https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/hgext/qimportbz/README

Comment 2

[Ed Morley [:emorley]]

Attachment: Fix version-control-tools repo READMEs

Fixes these three:

(In reply to Ed Morley [:edmorley UTC+0] from comment #1)
> Needs fixing:
...
> https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/
> hgext/bzexport/README
> https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/
> hgext/qbackout/README
> https://hg.mozilla.org/hgcustom/version-control-tools/file/eaa64fd26c39/
> hgext/qimportbz/README

Comment 3

[Ed Morley [:emorley]]

https://hg.mozilla.org/hgcustom/version-control-tools/rev/b885509b5574

Comment 4

[Ed Morley [:emorley]]

This just leaves:

(In reply to Ed Morley [:edmorley UTC+0] from comment #1)
> Needs fixing:
> https://bitbucket.org/sfink/trychooser/src/
> beed16e594800e2e0af4171d876d6c93390a2099/README.md?at=default

Steve, would you mind removing the trailing slash from the example hgrc [extensions] entry at the location linked here?

Commit message I used for comment 3, for inspiration:
"Bug 980295 - Remove trailing slash from README paths, for compat with hg < v3.0 on Windows"

Thanks :-)