4.0 features

.gitignore

@@ -1,7 +1,9 @@
 build
+source/_build/
 *.orig
 tx.exe
 GitExtensions.settings.backup
+.vscode/
 source/locale/.doctrees/
 /source/__pycache__/
 /source/extensions/__pycache__/

source/branches.rst

@@ -155,6 +155,14 @@ It is possible to modify the order, merge commits etc when committing.
 
 See :ref:`modify_history` for more information.
 
+Squash
+------
+
+Git has no native squash operation, it can be done with various combinations of rebase and reset.
+This is described in the `Git Extensions wiki <https://github.com/gitextensions/gitextensions/wiki/How-To%3A-Squash-and-Rebase-your-changes#squash>`_.
+
+See :ref:`modify_history` and `Git documentation <https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History>`_ for more information.
+
 Delete branch
 -------------
 

source/browse_repository.rst

@@ -4,10 +4,31 @@ Browse Repository
 =================
 
 You can browse a repository by starting Git Extensions and select the repository to open. The main window contains
-the revision graph (commit log). You could also open the ‘Browse’ window from the shell extensions and from Visual Studio.
+the revision graph (commit log). You could also open the ‘Browse’ window from the shell extensions and from :ref:`visual_studio`.
 
-View revision graph
--------------------
+TBD This page is incomplete
+
+The Browse window contains of several parts:
+
+* `Main toolbar`_
+* `Revision graph`_
+* `Tabs`_
+* `Sidepanel`_
+
+The `Sidepanel`_ and `Tabs`_ and can be hidden from the toolbar, as well as showing the `Commit`_ tab as a panel in the revision graph.
+
+.. _browse-main-toolbar:
+
+Main toolbar
+------------
+
+The main toolbar in Browse contains contains menus for other commands like
+:ref:`commit`, :ref:`stash` and :ref:`maintenance`.
+
+.. _browse-revision-graph:
+
+Revision graph
+--------------
 
 The full commit history can be browsed. There is a graph that shows branches and merges. You can show the difference
 between any two revisions by selecting them using ctrl-click.
@@ -18,14 +39,14 @@ The context menu for a commit can both execute Git commands and change the appea
 
 .. image:: /images/commit_contextual_menu.png
 
-Search or filter the commit history
------------------------------------
+Search
+^^^^^^
 
 You can find text in the commit messages or jump to a specific commit in the current commit history shown in Git
-Extensions. You can also filter the commit history so that fewer commits are shown.
+Extensions.
 
 Quick search in history
-^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""
 
 You can find a commit in the commit history that is shown in Git Extensions by searching for text in the commit message,
 branch label or tag. This is a quick search function. Simply click into the commit history to give that pane focus and
@@ -35,26 +56,86 @@ commit with matching text. You can search for the next or previous commit with m
 
 In ``Settings``, ``Git Extensions`` you can change the timeout for typing the text for the quick search.
 
+Navigation
+^^^^^^^^^^
 Go to a specific commit
-^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""
 
 You can jump to a particular commit in the commit history if you know the SHA, tag or branch. In fact you can use any
 expression valid for git-rev-parse. Select ``Navigate``, ``Go to commit`` or press ``Ctrl-Shift-G`` to open the ``Go
 to commit`` window. Enter an SHA or other term to be passed to git-rev-parse into the box at the top and click ``Go``,
 or select a branch or tag from one of the two combo boxes below.
 
+Filter
+^^^^^^
+
+You can also filter the commit history so that fewer commits are shown.
+
 Filter history
-^^^^^^^^^^^^^^
+""""""""""""""
 
 The history can be filtered using regular expressions and basic filter terms. Filtering will reduce the number of commits
 that are shown in the Git Extensions commit history. The quick filter in the toolbar filters by the commit message, the
 author and/or the committer.
 
 .. image:: /images/quick_filter.png
 
+.. _filter-file:
+
+xxx filter file
+
 In the context menu of the commit log you can open the advanced filter dialog. The advanced filter dialog allows you to
 filter for more specific commits. To remove the filter either remove the filter in the toolbar and press enter or remove the
 filter in the advanced filter dialog.
 
 .. image:: /images/advance_filter_dialog-menu.png
+
+xxx toolbar tooltip
+
 .. image:: /images/advance_filter_dialog.png
+
+.. _browse-reflog:
+
+Reflog
+""""""
+
+Tabs
+----
+
+`settings-tabs`_
+
+Commit
+^^^^^^
+
+also move
+
+.. _browse-tabs-diff:
+
+Diff
+^^^^
+
+Also describe different diff modes and range diff
+:ref:`settings-diff-viewer-show-file-differences-for-all-parents-in-browse-dialog`
+:ref:`settings-diff-viewer-show-all-available-difftools`
+
+Blame
+
+File tree
+^^^^^^^^^
+
+Blame
+
+GPG
+^^^
+
+Console
+^^^^^^^
+
+Build report
+^^^^^^^^^^^^
+Optional, only shown if the build server plugin is configured for the repo and if it has found a build for the selected commit.
+
+.. _browse-side-panel:
+
+Sidepanel
+---------

source/commit.rst

@@ -13,7 +13,7 @@ A commit is a set of changes with some extra information. Every commit contains
 
 Each commit creates a new revision of the source. Revisions are not tracked per file; each change creates a new
 revision of the complete source. Unlike most traditional source control management systems, revisions are not named
-using a revision number. Each revision is named using a SHA1, a 41 long characters cryptographically strong hash.
+using a revision number. Each revision is named using a SHA1, a 40 long characters cryptographically strong hash.
 
 Commit changes
 --------------

source/file_history.rst

@@ -1,8 +1,15 @@
+.. _file-history:
+
 File history
 ============
 
+``File tree`` is a separate form to view the history of a file or folder.
+Since Git Extensions 4.0 this functionality is included in :ref:`browse-repository`,
+see specifically :ref:`filter-file`.
+This form is deprecated and may be removed in future releases.
+
 To display the single file history, right click on a file name in the :ref:`browse-repository` ``File tree`` or in the ``Diff`` tab and select ``File history`` or ``Blame``.
-The single file history viewer shows all revisions of a single file. (This is available for submodules too, but the information is mostly not interesting.)
+The single file history viewer shows all revisions of a single file or submodules.
 
 .. image:: /images/context_menu_blame.png
 

source/getting_started.rst

@@ -4,59 +4,7 @@ Getting Started
 Installation
 ------------
 
-This section only covers Git Extensions installation, you will need to have Git for Windows installed: https://git-scm.com/download/win
-
-The Git Extensions installer can be found on `GitHub <https://github.com/gitextensions/gitextensions/releases/latest>`_.
-
-.. figure:: /images/install/welcome.png
-
-    Start installation.
-
-.. figure:: /images/install/scope.png
-
-    Installation scope.
-
-.. figure:: /images/install/destination.png
-
-    Destination folder.
-
-.. figure:: /images/install/options.png
-
-    Choose the options to install.
-
-.. figure:: /images/install/ssh.png
-
-    Choose the SSH client to use. PuTTY is the default because it has better Windows integration, but Pageant must be running.
-
-.. image:: /images/install/ready.png
-
-Portable
---------
-
-Git Extensions is also distributed as a portable .zip file, that only require unpacking. Some features like Windows shell integration and Visual Studio integration is not available with this package.
-
-Settings
---------
-
-Git must be installed prior to starting Git Extensions:
-
-.. image:: /images/install/git_missing.png
-
-First selection is language (depends on the installed languages):
-
-.. image:: /images/install/language.png
-
-All settings will be verified when Git Extensions is started for the first time. If Git Extensions requires
-any settings to be changed, the Settings dialog will be shown. All incorrect settings will be marked in red (for instance if the Git version is unsupported) and orange for not recommended setting (like that Git version is older than recommended).
-You can ask Git Extensions to try to fix the setting for you by clicking on it.
-When installing Git Extensions for the first time,
-you will normally be required to configure your username and email address.
-
-The settings dialog can be invoked at any time by selecting ``Settings`` from the ``Tools`` menu option.
-
-.. image:: /images/settings/settings.png
-
-For further information see :ref:`settings`.
+See :ref:`installation`.
 
 .. _start-page:
 

source/git_extensions.rst

@@ -9,10 +9,10 @@ There is also a Visual Studio extension to use Git from the Visual Studio IDE.
 Features
 --------
 
-* Windows Explorer integration for Git
 * Feature rich user interface for Git
 * 32bit and 64bit support
-* Visual Studio extension (2015-2017)
+* Windows Explorer integration for Git
+* Visual Studio extension (2015-2022)
 
 Specific in 2.5x releases:
 
@@ -38,7 +38,7 @@ Links
 
 See the following links for the Git Extensions download page, source code and documentation.
 
-* Download page: https://sourceforge.net/projects/gitextensions/
+* Download page: https://github.com/gitextensions/gitextensions/releases
 * Source Code: https://github.com/gitextensions/gitextensions
 * Source Code Issue tracker: https://github.com/gitextensions/gitextensions/issues
 * Documentation: https://github.com/gitextensions/GitExtensionsDoc

source/index.rst

@@ -2,29 +2,30 @@ Git Extensions |release| Manual
 ===============================
 
 .. toctree::
-   :maxdepth: 4
+  :maxdepth: 4
 
-   git_extensions
-   getting_started
-   settings
-   browse_repository
-   file_history
-   commit
-   stash
-   tag
-   branches
-   patches
-   remote_feature
-   merge_conflicts
-   modify_history
-   notes
-   submodules
-   worktrees
-   maintenance
-   translations
-   windows_explorer
-   visual_studio
-   command_line
-   z_appendix
-   plugins
+  git_extensions
+  install
+  getting_started
+  settings
+  browse_repository
+  file_history
+  commit
+  stash
+  tag
+  branches
+  patches
+  remote_feature
+  merge_conflicts
+  modify_history
+  notes
+  submodules
+  worktrees
+  maintenance
+  translations
+  windows_explorer
+  other_tools
+  command_line
+  z_appendix
+  plugins
 

source/install.rst

@@ -0,0 +1,58 @@
+.. _installation:
+
+Installation
+============
+
+Windows installer
+-----------------
+
+This section only covers Git Extensions installation, you will need to have Git for Windows installed: https://git-scm.com/download/win
+
+The Git Extensions installer can be found on `GitHub <https://github.com/gitextensions/gitextensions/releases/latest>`_.
+
+.. figure:: /images/install/welcome.png
+
+    Start installation.
+
+.. figure:: /images/install/scope.png
+
+    Installation scope.
+
+.. figure:: /images/install/destination.png
+
+    Destination folder.
+
+.. figure:: /images/install/options.png
+
+    Choose the options to install.
+
+.. image:: /images/install/ready.png
+
+Portable
+--------
+
+Git Extensions is also distributed as a portable .zip file, that only require unpacking to a new directory (migrate settings files and theme manually).
+Some features like :ref:`windows-explorer` is not available with this package.
+
+Settings
+--------
+
+Git must be installed prior to starting Git Extensions:
+
+.. image:: /images/install/git_missing.png
+
+First selection is language (depends on the installed languages):
+
+.. image:: /images/install/language.png
+
+All settings will be verified when Git Extensions is started for the first time. If Git Extensions requires
+any settings to be changed, the Settings dialog will be shown. All incorrect settings will be marked in red (for instance if the Git version is unsupported) and orange for not recommended setting (like that Git version is older than recommended).
+You can ask Git Extensions to try to fix the setting for you by clicking on it.
+When installing Git Extensions for the first time,
+you will normally be required to configure your username and email address.
+
+The settings dialog can be invoked at any time by selecting ``Settings`` from the ``Tools`` menu option.
+
+.. image:: /images/settings/settings.png
+
+For further information see :ref:`settings`.

source/maintenance.rst

@@ -22,7 +22,7 @@ can restore deleted items if you need to. Git will delete removed items when the
 git database``.
 
 Commits without branches or tags can be shown with Git reflog https://git-scm.com/docs/git-reflog
-The easiest way to view the commits is to show Git reflog in the revision graph:
+The easiest way to view the commits is to show :ref:`browse-reflog` :ref:`browse-repository`.
 
 .. image:: /images/reflog_show.png