Git-cola

======

Usability, bells and whistles
-----------------------------
* Double-clicking dock widgets no longer creates sub-windows when the layout is locked.
(`1176 <https://github.com/git-cola/git-cola/issues/1176>`_)
(`1198 <https://github.com/git-cola/git-cola/pull/1198>`_)

Fixes
-----
* We now guard against `locale.getdefaultlocale()` returning `None` in some
configurations, notably on macOS if none of 'LC_ALL', 'LC_CTYPE', 'LANG' or 'LANGUAGE'
are defined.
(`1234 <https://github.com/git-cola/git-cola/issues/1234>`_)

* The preferences dialog has been fixed to properly handle booleans.
(`1235 <https://github.com/git-cola/git-cola/pull/1235>`_)

* The `docs/` directory was restructured to avoid missing `setup.py` errors.
`share/doc/git-cola` is now a symlink pointing to `docs/`.
(`1230 <https://github.com/git-cola/git-cola/issues/1230>`_)

* Message boxes could sometimes display off-screen or using geometry that is larger
than the current desktop. Message box sizes are now clamped to the desktop size.
(`1228 <https://github.com/git-cola/git-cola/issues/1228>`_)

======

Breaking Changes
----------------
These changes are primarily breaking changes for packagers of Git Cola.
For example, Linux distribution and Homebrew package maintainers may need to
be aware of these changes.

Changes have been made build infrastructure and the resulting filesystem artifacts.

* The build system is now Python3-only and has been modernized for PEP-517/518.
While Git Cola still builds and runs under Python2, it is no longer officially
supported and may stop working in a future release without notice.
(`1201 <https://github.com/git-cola/git-cola/issues/1201>`_)

* The `!/usr/bin/env python` shebang lines in the `git-cola` and `git-dag` wrapper
scripts have been updated to use `python3`.
(`1204 <https://github.com/git-cola/git-cola/pull/1204>`_)

* The build system was switched to `setuptools` and no longer depends on `distutils`.
``python setup.py {build,install,build_pot,build_mo}`` are no longer provided.
Use the https://pypa-build.readthedocs.io/en/stable/installation.html
``python -m build`` tool to generate sdist and wheel distributions,
and ``pip install .`` to install Git Cola from source.
(`1204 <https://github.com/git-cola/git-cola/pull/1204>`_)

* The `git-cola`, `git-dag` and `git-cola-sequence-editor` commands are now installed
using setuptools entry points.

* The `bin/` wrapper scripts in the source tree continue to be provided for convenience
but they are not the scripts that get installed.

* The `qtpy` Python package is no longer installed alongside the `cola` Python package.

* The `cola` package is now installed into the standard Python site-packages location.

* The `share/git-cola/lib` private Python modules directory no longer exists.

* The `NO_VENDOR_LIBS` and `NO_PRIVATE_LIBS` Makefile options are no longer necessary.

* The `share/git-cola` filesystem namespace no longer exists. All of cola's package data
is distributed alongside the `cola` module as package data.

* Building the Sphinx documentation now also requires the `jaraco.packaging` and
`rst.linker` packages. See `setup.cfg` for the package requirement details.

Usability, bells and whistles
-----------------------------
* `Custom UI themes
<https://git-cola.readthedocs.io/en/latest/git-cola.html#custom-themes>`_
can be used by adding `*.qss` Qt stylesheet files to `~/.config/git-cola/themes/`.
(`1222 <https://github.com/git-cola/git-cola/pull/1222>`_)
(`1226 <https://github.com/git-cola/git-cola/pull/1226>`_)

* Git Cola now keeps track of child Browser windows and will close all of them when
the main window is closed.
(`1200 <https://github.com/git-cola/git-cola/pull/1200>`_)

Fixes
-----
* Staging conflicted binary files has been fixed to avoid Unicode decoding errors.
(`1189 <https://github.com/git-cola/git-cola/issues/1189>`_)

* Ensure that secure permissions are used when creating temporary files.
(`1209 <https://github.com/git-cola/git-cola/pull/1209>`_)

* The line numbering in the diff viewer was corrected when displaying merge diffs.
(`1208 <https://github.com/git-cola/git-cola/pull/1208>`_)

* Documentation typo fixes.
(`1193 <https://github.com/git-cola/git-cola/pull/1193>`_)

* Git Cola was revamped to use Qt signals and slots for all of its notifications.
This made its notification system more robust.
(`1202 <https://github.com/git-cola/git-cola/pull/1202>`_)
(`1203 <https://github.com/git-cola/git-cola/pull/1203>`_)
(`1205 <https://github.com/git-cola/git-cola/pull/1205>`_)
(`1206 <https://github.com/git-cola/git-cola/pull/1206>`_)

Packaging
---------
* `vcruntime140.dll` and `msvcp140.dll` are now included in the Windows installation.
(`1207 <https://github.com/git-cola/git-cola/pull/1207>`_)

=======

Usability, bells and whistles
-----------------------------
* The git config guitool action can now be grouped under user-defined menus.
This is done by using slash (``/``) delimiters in the action name.
Entries before the final slash are treated like sub-menus inside the
top-level ``Actions`` menu.
(`1150 <https://github.com/git-cola/git-cola/issues/1150>`_)

* Toolbars now have a full set of icons. The icons follow the system theme
and can be configured to display text, just icons, or text and icons.
(`1177 <https://github.com/git-cola/git-cola/pull/1177>`_)

* The startup dialog will now open the selected repository when the "enter"
key is pressed.
(`1162 <https://github.com/git-cola/git-cola/issues/1162>`_)

* ``Shift+S`` will stage selected lines (in addition to ``s``).
(`1187 <https://github.com/git-cola/git-cola/issues/1187>`_)

Fixes
-----
* The vendored qtpy library was patched to retain Python2 compatibility.

* The "Unstage" toolbar action was fixed.
(`1178 <https://github.com/git-cola/git-cola/issues/1178>`_)

* We now avoid `QWidget::setWidth(float)` for compatibility with newer Qt versions.
(`1183 <https://github.com/git-cola/git-cola/pull/1183>`_)

* Documentation typo fixes.
(`1185 <https://github.com/git-cola/git-cola/pull/1185>`_)

Translations
------------
* Updated Polish translation.
(`1184 <https://github.com/git-cola/git-cola/pull/1184>`_)

Development
-----------
* Git Cola now uses Github Actions for running its continuous integration tests.
(`1179 <https://github.com/git-cola/git-cola/pull/1179>`_)

=======

Usability, bells and whistles
-----------------------------
* The Status tool was improved to better retain selected files when
the state changes and the display is refreshed.
(`1130 <https://github.com/git-cola/git-cola/issues/1130>`_)
(`1131 <https://github.com/git-cola/git-cola/pull/1131>`_)

* The Diff editor can now stage selected lines for untracked files.
Git Cola will detect when a file is untracked and will allow you to
partially stage it, just like existing tracked files.
(`1146 <https://github.com/git-cola/git-cola/pull/1146>`_)
(`1084 <https://github.com/git-cola/git-cola/issues/1084>`_)

* Diffing of staged files has been implemented for repositories that contain
no commits.
(`1149 <https://github.com/git-cola/git-cola/pull/1149>`_)
(`1110 <https://github.com/git-cola/git-cola/issues/1110>`_)

* Documentation improvements and typo fixes.
(`1163 <https://github.com/git-cola/git-cola/pull/1163>`_)
(`1164 <https://github.com/git-cola/git-cola/pull/1164>`_)

Security
--------
* The `FIPS security mode <https://github.com/python/cpython/issues/53462>`_
is now supported by Git Cola when running on FIPS-enabled Python
(Python 3.9+ or centos8/rhel8's patched Python 3.6).
(`1157 <https://github.com/git-cola/git-cola/issues/1157>`_)

Fixes
-----
* The `argparse` usage was adjusted to remain compatible with older Pythons.
(`1155 <https://github.com/git-cola/git-cola/issues/1155>`_)

* The window restoration logic was fixed to properly save/restore settings
when different languages are used.
(`1071 <https://github.com/git-cola/git-cola/issues/1071>`_)
(`1161 <https://github.com/git-cola/git-cola/issues/1161>`_)
(`382 <https://github.com/git-cola/git-cola/issues/382>`_)

* `git dag` no longer passes floats to `QPen::setWidth()` for better compatibility.
(`bz 2014950 <https://bugzilla.redhat.com/show_bug.cgi?id=2014950>`_)

Packaging
---------
* The Windows installer was slimmed down by removing unused Qt DLLs.
(`1152 <https://github.com/git-cola/git-cola/pull/1152>`_)

=======

Fixes
-----
* Patch release to fix a typo in the Interactive Rebase feature.

=====

Usability, bells and whistles
-----------------------------
* The git config reader now supports the `include.path` directive
for including config files.
(`1136 <https://github.com/git-cola/git-cola/issues/1136>`_)
(`1137 <https://github.com/git-cola/git-cola/pull/1137>`_)

* The dialog for selecting commits now support filtering.
(`1121 <https://github.com/git-cola/git-cola/pull/1121>`_)

* The diff editor now wraps long lines by default. The diff options
menu can be used to enable/disable line wrapping.
(`1123 <https://github.com/git-cola/git-cola/pull/1123>`_)

* Git Cola now honors `core.hooksPath` for configuring custom Git hooks,
which was introduced in Git v2.9.
(`1118 <https://github.com/git-cola/git-cola/issues/1118>`_)

* A new `Ctrl + Shift + S` hotkey was added for staging/unstaging all
files, both modified and untracked.

* The `Status` tool now supports `Ctrl + A` for selecting all files and
it behaves more predictably when performing operations when multiple
categories of files are selected (e.g. when both modified and untracked
header items are selected).
(`1117 <https://github.com/git-cola/git-cola/issues/1117>`_)

Translations
------------
* Updated Hungarian translation.
(`1135 <https://github.com/git-cola/git-cola/pull/1135>`_)

Fixes
-----
* The "Interactive Rebase" feature was updated to work with Windows.

* `make install-man` was updated to support Sphinx 4.0.
(`1141 <https://github.com/git-cola/git-cola/issues/1141>`_)

* `git cola --help-commands` was updated for newer versions of argparse.
(`1133 <https://github.com/git-cola/git-cola/issues/1133>`_)

Development
-----------
* Git Cola can now be started as a Python module.
(`1119 <https://github.com/git-cola/git-cola/pull/1119>`_)