( )⚙ D7168 packaging: install .rc files to hgrc.d

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7168

packaging: install .rc files to hgrc.d
ClosedPublic

Authored by indygreg on Oct 23 2019, 9:54 PM.

Details

Reviewers
mharbison72
Group Reviewers
hg-reviewers
Commits
rHG14ce03e13508: packaging: install .rc files to hgrc.d
Summary

Currently, Inno installs these .rc files to a default.d
directory and WiX to a hgrc.d directory.

Mercurial automatically loads files in an hgrc.d directory
next to the executable and in an "internal" default.d directory.
This "internal" directory is util.datadir, which on Windows
installs made with py2exe is the directory containing hg.exe.
So on Windows both hgrc.d and default.d directories relative
to hg.exe are loaded.

For the install layout, I think it makes sense for hgrc.d to
be used, as that path is documented as non-internal. So this
commit changes the Inno install layout to use hgrc.d instead
of default.d.

.. bc::

Changed default config file location in Windows .exe installers

Mercurial's installer installs some default .rc config
files. Previously, these were installed in a default.d
directory. These are now installed in an hgrc.d directory.

Custom default.d/*.rc files should still be loaded. But it
is recommended to move these to hgrc.d/*.rc.

This change only affects the .exe installers (not the .msi
installers).

Diff Detail

Repository
rHG Mercurial
Branch
stable
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.Oct 23 2019, 9:54 PM
mharbison72 added a subscriber: mharbison72.Oct 24 2019, 11:06 PM

I think this change (and the entire series) is great!

Custom default.d/*.rc files should still be loaded. But it
is recommended to move these to hgrc.d/*.rc.

Is it a good idea to encourage people to modify the installation directory? I thought it was off limits on Windows, though a custom file does seem to survive an uninstall/install cycle of thg.

I do miss having a global directory like /etc/mercurial/hgrc.d. Loading relative to the exe isn't exactly global, since a vanilla hg vs a thg install will use different directories. I wonder if we can slip in a global directory under %ProgramData% or %AppData% or similar.

indygreg added a comment.Oct 24 2019, 11:19 PM
In D7168#105269, @mharbison72 wrote:

Is it a good idea to encourage people to modify the installation directory? I thought it was off limits on Windows, though a custom file does seem to survive an uninstall/install cycle of thg.
I do miss having a global directory like /etc/mercurial/hgrc.d. Loading relative to the exe isn't exactly global, since a vanilla hg vs a thg install will use different directories. I wonder if we can slip in a global directory under %ProgramData% or %AppData% or similar.

I agree that we should consider a better solution here. The compatibility story on Windows is not great and there's lots of room for improvement.

Looking in %ProgramData% or %AppData% in addition to a directory next to the executable and in your home directory feels appropriate. As you say, it mirrors on POSIX works with /etc.

indygreg updated this revision to Diff 17402.Oct 24 2019, 11:34 PM
martinvonz added a subscriber: martinvonz.Nov 8 2019, 7:03 PM
In D7168#105270, @indygreg wrote:
In D7168#105269, @mharbison72 wrote:

Is it a good idea to encourage people to modify the installation directory? I thought it was off limits on Windows, though a custom file does seem to survive an uninstall/install cycle of thg.
I do miss having a global directory like /etc/mercurial/hgrc.d. Loading relative to the exe isn't exactly global, since a vanilla hg vs a thg install will use different directories. I wonder if we can slip in a global directory under %ProgramData% or %AppData% or similar.

I agree that we should consider a better solution here. The compatibility story on Windows is not great and there's lots of room for improvement.
Looking in %ProgramData% or %AppData% in addition to a directory next to the executable and in your home directory feels appropriate. As you say, it mirrors on POSIX works with /etc.

@mharbison72, are you okay with what Greg says?

I'll queue the patches up but not including this one for now. Thank, Greg! I don't really know what all these patches do, but the commit messages sound reasonable :)

mharbison72 accepted this revision.Nov 8 2019, 8:09 PM
In D7168#107707, @martinvonz wrote:
In D7168#105270, @indygreg wrote:
In D7168#105269, @mharbison72 wrote:

Is it a good idea to encourage people to modify the installation directory? I thought it was off limits on Windows, though a custom file does seem to survive an uninstall/install cycle of thg.
I do miss having a global directory like /etc/mercurial/hgrc.d. Loading relative to the exe isn't exactly global, since a vanilla hg vs a thg install will use different directories. I wonder if we can slip in a global directory under %ProgramData% or %AppData% or similar.

I agree that we should consider a better solution here. The compatibility story on Windows is not great and there's lots of room for improvement.
Looking in %ProgramData% or %AppData% in addition to a directory next to the executable and in your home directory feels appropriate. As you say, it mirrors on POSIX works with /etc.

@mharbison72, are you okay with what Greg says?
I'll queue the patches up but not including this one for now. Thank, Greg! I don't really know what all these patches do, but the commit messages sound reasonable :)

Yeah, I agree with that. My comment was mostly focused on what was to be indicated in the release notes.

martinvonz added a comment.Nov 8 2019, 8:38 PM
In D7168#107789, @mharbison72 wrote:
In D7168#107707, @martinvonz wrote:
In D7168#105270, @indygreg wrote:
In D7168#105269, @mharbison72 wrote:

Is it a good idea to encourage people to modify the installation directory? I thought it was off limits on Windows, though a custom file does seem to survive an uninstall/install cycle of thg.
I do miss having a global directory like /etc/mercurial/hgrc.d. Loading relative to the exe isn't exactly global, since a vanilla hg vs a thg install will use different directories. I wonder if we can slip in a global directory under %ProgramData% or %AppData% or similar.

I agree that we should consider a better solution here. The compatibility story on Windows is not great and there's lots of room for improvement.
Looking in %ProgramData% or %AppData% in addition to a directory next to the executable and in your home directory feels appropriate. As you say, it mirrors on POSIX works with /etc.

@mharbison72, are you okay with what Greg says?
I'll queue the patches up but not including this one for now. Thank, Greg! I don't really know what all these patches do, but the commit messages sound reasonable :)

Yeah, I agree with that. My comment was mostly focused on what was to be indicated in the release notes.

Thanks! I'll queue the rest of the series as well then.

indygreg added a commit: rHG14ce03e13508: packaging: install .rc files to hgrc.d.Nov 11 2019, 4:09 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG14ce03e13508: packaging: install .rc files to hgrc.d (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 17402

contrib/packaging/hgpackaging/py2exe.py

('dist/lib/*.pyd', 'lib/'), ('dist/lib/*.pyd', 'lib/'),
('dist/lib/library.zip', 'lib/'), ('dist/lib/library.zip', 'lib/'),
('dist/Microsoft.VC*.CRT.manifest', './'), ('dist/Microsoft.VC*.CRT.manifest', './'),
('dist/msvc*.dll', './'), ('dist/msvc*.dll', './'),
('dist/python*.dll', './'), ('dist/python*.dll', './'),
('doc/*.html', 'doc/'), ('doc/*.html', 'doc/'),
('doc/style.css', 'doc/'), ('doc/style.css', 'doc/'),
('mercurial/help/**/*.txt', 'help/'), ('mercurial/help/**/*.txt', 'help/'),
('mercurial/default.d/*.rc', 'default.d/'), ('mercurial/default.d/*.rc', 'hgrc.d/'),
('mercurial/locale/**/*', 'locale/'), ('mercurial/locale/**/*', 'locale/'),
('mercurial/templates/**/*', 'Templates/'), ('mercurial/templates/**/*', 'Templates/'),
('CONTRIBUTORS', 'Contributors.txt'), ('CONTRIBUTORS', 'Contributors.txt'),
('COPYING', 'Copying.txt'), ('COPYING', 'Copying.txt'),
] ]
def build_py2exe( def build_py2exe(

contrib/packaging/inno/mercurial.iss

[Files] [Files]
{% for entry in package_files -%} {% for entry in package_files -%}
Source: {{ entry.source }}; DestDir: {{ entry.dest_dir }} Source: {{ entry.source }}; DestDir: {{ entry.dest_dir }}
{%- if entry.metadata %}; {{ entry.metadata }}{% endif %} {%- if entry.metadata %}; {{ entry.metadata }}{% endif %}
{% endfor %} {% endfor %}
[INI] [INI]
Filename: {app}\Mercurial.url; Section: InternetShortcut; Key: URL; String: https://mercurial-scm.org/ Filename: {app}\Mercurial.url; Section: InternetShortcut; Key: URL; String: https://mercurial-scm.org/
Filename: {app}\default.d\editor.rc; Section: ui; Key: editor; String: notepad Filename: {app}\hgrc.d\editor.rc; Section: ui; Key: editor; String: notepad
[UninstallDelete] [UninstallDelete]
Type: files; Name: {app}\Mercurial.url Type: files; Name: {app}\Mercurial.url
Type: filesandordirs; Name: {app}\default.d Type: filesandordirs; Name: {app}\hgrc.d
[Icons] [Icons]
Name: {group}\Uninstall Mercurial; Filename: {uninstallexe} Name: {group}\Uninstall Mercurial; Filename: {uninstallexe}
Name: {group}\Mercurial Command Reference; Filename: {app}\Docs\hg.1.html Name: {group}\Mercurial Command Reference; Filename: {app}\Docs\hg.1.html
Name: {group}\Mercurial Configuration Files; Filename: {app}\Docs\hgrc.5.html Name: {group}\Mercurial Configuration Files; Filename: {app}\Docs\hgrc.5.html
Name: {group}\Mercurial Ignore Files; Filename: {app}\Docs\hgignore.5.html Name: {group}\Mercurial Ignore Files; Filename: {app}\Docs\hgignore.5.html
Name: {group}\Mercurial Web Site; Filename: {app}\Mercurial.url Name: {group}\Mercurial Web Site; Filename: {app}\Mercurial.url