Skip to content

Commit

Permalink
doc: refresh sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davvid committed Dec 29, 2023
1 parent 177b996 commit eab80c8
Show file tree
Hide file tree
Showing 20 changed files with 1,104 additions and 1,018 deletions.
56 changes: 33 additions & 23 deletions share/doc/git-cola/git-cola.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
===========
git-cola(1)
===========
========
git-cola
========

SYNOPSIS
========
git cola [options] [sub-command]
``git cola [options] [sub-command]``


DESCRIPTION
===========
Git Cola is a sleek and powerful Git GUI.


OPTIONS
=======

``--amend``
-----------
Start `git cola` in amend mode.
Expand Down Expand Up @@ -41,9 +42,9 @@ Show usage and optional arguments.
-------------------
Show available sub-commands.


SUB-COMMANDS
============

am
--
Apply patches.
Expand Down Expand Up @@ -116,6 +117,7 @@ version
-------
Print the `git cola` version.


CONFIGURE YOUR EDITOR
=====================
The editor used by `Ctrl-e` is configured from the Preferences screen.
Expand Down Expand Up @@ -193,6 +195,7 @@ You can see the available shortcuts by pressing pressing the ``?`` key,
choosing ``Help -> Keyboard shortcuts`` from the main menu,
or by consulting the `git cola keyboard shortcuts reference <https://git-cola.github.io/share/doc/git-cola/hotkeys.html>`_.


TOOLS
=====
The `git cola` interface is composed of various cooperating tools.
Expand Down Expand Up @@ -349,7 +352,6 @@ an empty area in the `Status` tool.

COMMIT MESSAGE EDITOR
=====================

The commit message editor is a simple text widget
for entering commit messages.

Expand Down Expand Up @@ -407,7 +409,6 @@ Keeping commit messages less than 76-characters wide is encouraged.
is a great tool but long lines mess up its formatting for everyone else,
so please be mindful when writing commit messages.


Amend Last Commit
-----------------
Clicking on `Amend Last Commit` makes `git cola` amend the previous commit
Expand Down Expand Up @@ -443,9 +444,9 @@ To override the default path to this hook set the
hook script. This is useful if you would like to use a common hook
across all repositories.


BRANCHES
========

The `Branches` tool provides a visual tree to navigate through the branches.
The tree has three main nodes `Local Branch`, `Remote Branch` and `Tags`.
Branches are grouped by their name divided by the character '/'.Ex::
Expand Down Expand Up @@ -524,6 +525,7 @@ patches after they have all been found. This allows you
to control the order in which patches are applied by placing
patchsets into alphanumerically-sorted directories.


CUSTOM WINDOW SETTINGS
======================
`git cola` remembers modifications to the layout and arrangement
Expand All @@ -533,6 +535,7 @@ and restored at application shutdown/startup.
`git cola` can be configured to not save custom layouts by unsetting
the `Save Window Settings` option in the `git cola` preferences.


DARK MODE AND WINDOW MANAGER THEMES
===================================
Git Cola contains a ``default`` theme which follows the current Qt style and a
Expand Down Expand Up @@ -882,14 +885,15 @@ requires shell quoting.
This configuration variable is for custom terminals outside of the builtin set.
The table below shows the builtin configuration.

=================== ======================= =============================
Terminal ``cola.terminal`` ``cola.terminalshellquote``
=================== ======================= =============================
gnome-terminal ``gnome-terminal --`` ``false``
konsole ``konsole -e`` ``false``
xfce4-terminal ``xfce4-terminal -e`` ``true``
xterm ``xterm -e`` ``false``
=================== ======================= =============================
.. code-block:: text
Terminal cola.terminal cola.terminalshellquote
-------- ------------- -----------------------
gnome-terminal "gnome-terminal --" false
konsole "konsole -e" false
xfce4-terminal "xfce4-terminal -e" true
xterm "xterm -e" false
cola.textwidth
--------------
Expand Down Expand Up @@ -1056,6 +1060,7 @@ Your full name to be recorded in any newly created commits.
Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
environment variables.


ENVIRONMENT VARIABLES
=====================

Expand Down Expand Up @@ -1208,6 +1213,7 @@ Avoid creating shortcuts that conflict with existing built-in `git cola`
shortcuts. Creating a conflict will result in no action when the shortcut
is used.


SETTING UP CREDENTIAL HELPERS
=============================
Git has robust support for automatically handling credentials.
Expand All @@ -1217,6 +1223,7 @@ Credentials helpers will get used automatically by Git Cola.

See https://git-scm.com/doc/credential-helpers for more details.


SETTING UP GPG FOR SIGNED COMMITS
=================================
When creating signed commits, `gpg` will attempt to read your password from the
Expand Down Expand Up @@ -1285,6 +1292,7 @@ prior to launching `git cola`.::
eval $(gpg-agent --daemon)
git cola


SHELL COMPLETIONS
=================

Expand All @@ -1296,6 +1304,7 @@ The completion scripts and instructions are included in Git Cola's

* `Setup instructions <https://gitlab.com/git-cola/git-cola/-/blob/main/contrib/README.md>`_


WINDOWS NOTES
=============

Expand All @@ -1319,8 +1328,10 @@ Please see the following links for more details.

https://stackoverflow.com/questions/18683092/how-to-run-ssh-add-on-windows


FIPS SECURITY MODE
==================

`FIPS Security Mode <https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/FIPS_Mode_-_an_explanation>`_
is available in newer versions of Python. These include Python 3.9+ and the
patched Python 3.6 used by CentOS8/RHEL8 (and possibly others).
Expand All @@ -1330,17 +1341,16 @@ mode when available. Git Cola does not use the MD5 value for security purposes.
MD5 is used only for the purposes of implementing the ``cola/gravatar.py``
Gravatar client.


LINKS
=====

Git Cola's Git Repository
-------------------------
https://github.com/git-cola/git-cola/
* `Primary repository <https://gitlab.com/git-cola/git-cola/>_`.
* `Mirror repository <https://github.com/git-cola/git-cola/>_`.


Git Cola Homepage
-----------------
https://git-cola.github.io/

Mailing List
------------
https://groups.google.com/group/git-cola
https://git-cola.gitlab.io/
43 changes: 31 additions & 12 deletions share/doc/git-cola/git-dag.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,63 @@
==========
git-dag(1)
==========
=======
git-dag
=======

SYNOPSIS
========
git dag [options] [<since>..<until>] [[--] [<path>...]]
``git dag [options] [<revision-range>] [[--] [<path>...]]``


DESCRIPTION
===========
`git-dag` is a powerful Git history visualizer.
`git-dag` presents powerful `git log` features in a simple-to-use
graphical interface.
`git-dag` is an advanced Git history visualizer that presents ``git log``'s
powerful features in an easy to use graphical interface.


OPTIONS
=======
``<revision-range>``
--------------------
Show only commits in the specified revision range.
When no ``<revision-range>`` is specified, it defaults to ``HEAD``
(i.e. the whole history leading to the current commit).

``origin..HEAD`` specifies all the commits reachable from the current commit
(i.e. ``HEAD``), but not from ``origin``.

For a complete list of ways to spell ``<revision-range>``, see the Specifying Ranges
section of `gitrevisions(7) <https://git-scm.com/docs/gitrevisions>`_
(``man gitrevisions``).


``--prompt``
------------
Prompt for a Git repository instead of using the current directory.

``-r, --repo <path>``
---------------------
Run `git dag` on the git repository in `<path>`.
Open the git repository located at ``<path>``.
Defaults to the current directory.

``--version``
-------------
Print the `git dag` version and exit.
Print the version number and exit.

``-h, --help``
--------------
Show usage and optional arguments.

Log Options
===========
The `Log` prompt allows you to pass arguments to `git log`.

Log Arguments
=============
The ``Log`` text field allows you to pass arguments to `git log`.
This can be used to filter the displayed history, for example
entering `main -- Makefile` will display only commits on the
`main` branch that touch the `Makefile`.

The `Log` text field lets you interactively edit and replace the
``[<revision-range>] [[--] [<path>...]]`` arguments that were initially
specified on the command-line.

CONTEXT-MENU ACTIONS
====================
The right-click menu can be used to perform various actions.
Expand Down
11 changes: 11 additions & 0 deletions share/doc/git-cola/hotkeys.html
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,17 @@
<td>Show and hide tools<br>
# is 1 for commit, 2 for status, 3 for diff, etc.</td>
</tr>
<tr>
<td class="shortcut">Ctrl + Space</td>
<td>:</td>
<td>Display autocomplete options</td>
</tr>
<tr>
<td class="shortcut">Ctrl + Shift + #</td>
<td>:</td>
<td>Show and hide tools<br>
# is 1 for commit, 2 for status, 3 for diff, etc.</td>
</tr>
</table>

<!-- Remotes -->
Expand Down
5 changes: 5 additions & 0 deletions share/doc/git-cola/hotkeys_de.html
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,11 @@
<td>:</td>
<td>Werkzeuge anzeigen und verstecken</td>
</tr>
<tr>
<td class="shortcut">Ctrl + Space</td>
<td>:</td>
<td>Display autocomplete options</td>
</tr>
</table>

<!-- Diff -->
Expand Down
5 changes: 5 additions & 0 deletions share/doc/git-cola/hotkeys_zh_CN.html
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,11 @@
<td>:</td>
<td>显示/隐藏工具</td>
</tr>
<tr>
<td class="shortcut">Ctrl + Space</td>
<td>:</td>
<td>Display autocomplete options</td>
</tr>
</table>

<!-- Diff -->
Expand Down
5 changes: 5 additions & 0 deletions share/doc/git-cola/hotkeys_zh_TW.html
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,11 @@
<td>顯示或隱藏指定工具<br>
對提交版本工具來說 # 為 1、對版控庫狀態工具來說 # 為 2、對內容差異工具來說 # 為 3,依此類推</td>
</tr>
<tr>
<td class="shortcut">Ctrl + Space</td>
<td>:</td>
<td>Display autocomplete options</td>
</tr>
</table>

<!-- Diff -->
Expand Down
12 changes: 6 additions & 6 deletions share/doc/git-cola/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; git-cola 4.4.1 documentation</title>
<title>Index &mdash; Python 4.4.1 documentation</title>
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@


<a href="index.html" class="icon icon-home">
git-cola
Python
</a>
<div class="version">
4.4.1
Expand All @@ -43,8 +43,8 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="git-cola.html">git-cola(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="git-dag.html">git-dag(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="git-cola.html">git-cola</a></li>
<li class="toctree-l1"><a class="reference internal" href="git-dag.html">git-dag</a></li>
<li class="toctree-l1"><a class="reference internal" href="thanks.html">Thanks</a></li>
</ul>
<ul>
Expand All @@ -57,7 +57,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">git-cola</a>
<a href="index.html">Python</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -89,7 +89,7 @@ <h1 id="index">Index</h1>
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2007-2022, David Aguilar and contributors.</p>
<p>&#169; Copyright .</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Loading

0 comments on commit eab80c8

Please sign in to comment.