Skip to content

Commit eab80c8

Browse files
committed
doc: refresh sphinx docs
1 parent 177b996 commit eab80c8

20 files changed

+1104
-1018
lines changed

share/doc/git-cola/git-cola.rst

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
===========
2-
git-cola(1)
3-
===========
1+
========
2+
git-cola
3+
========
44

55
SYNOPSIS
66
========
7-
git cola [options] [sub-command]
7+
``git cola [options] [sub-command]``
8+
89

910
DESCRIPTION
1011
===========
1112
Git Cola is a sleek and powerful Git GUI.
1213

14+
1315
OPTIONS
1416
=======
15-
1617
``--amend``
1718
-----------
1819
Start `git cola` in amend mode.
@@ -41,9 +42,9 @@ Show usage and optional arguments.
4142
-------------------
4243
Show available sub-commands.
4344

45+
4446
SUB-COMMANDS
4547
============
46-
4748
am
4849
--
4950
Apply patches.
@@ -116,6 +117,7 @@ version
116117
-------
117118
Print the `git cola` version.
118119

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

198+
196199
TOOLS
197200
=====
198201
The `git cola` interface is composed of various cooperating tools.
@@ -349,7 +352,6 @@ an empty area in the `Status` tool.
349352

350353
COMMIT MESSAGE EDITOR
351354
=====================
352-
353355
The commit message editor is a simple text widget
354356
for entering commit messages.
355357

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

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

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

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

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

885-
=================== ======================= =============================
886-
Terminal ``cola.terminal`` ``cola.terminalshellquote``
887-
=================== ======================= =============================
888-
gnome-terminal ``gnome-terminal --`` ``false``
889-
konsole ``konsole -e`` ``false``
890-
xfce4-terminal ``xfce4-terminal -e`` ``true``
891-
xterm ``xterm -e`` ``false``
892-
=================== ======================= =============================
888+
.. code-block:: text
889+
890+
Terminal cola.terminal cola.terminalshellquote
891+
-------- ------------- -----------------------
892+
gnome-terminal "gnome-terminal --" false
893+
konsole "konsole -e" false
894+
xfce4-terminal "xfce4-terminal -e" true
895+
xterm "xterm -e" false
896+
893897
894898
cola.textwidth
895899
--------------
@@ -1056,6 +1060,7 @@ Your full name to be recorded in any newly created commits.
10561060
Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
10571061
environment variables.
10581062

1063+
10591064
ENVIRONMENT VARIABLES
10601065
=====================
10611066

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

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

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

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

1295+
12881296
SHELL COMPLETIONS
12891297
=================
12901298

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

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

1307+
12991308
WINDOWS NOTES
13001309
=============
13011310

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

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

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

1344+
13331345
LINKS
13341346
=====
13351347

13361348
Git Cola's Git Repository
13371349
-------------------------
1338-
https://github.com/git-cola/git-cola/
1350+
* `Primary repository <https://gitlab.com/git-cola/git-cola/>_`.
1351+
* `Mirror repository <https://github.com/git-cola/git-cola/>_`.
1352+
13391353

13401354
Git Cola Homepage
13411355
-----------------
1342-
https://git-cola.github.io/
1343-
1344-
Mailing List
1345-
------------
1346-
https://groups.google.com/group/git-cola
1356+
https://git-cola.gitlab.io/

share/doc/git-cola/git-dag.rst

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,63 @@
1-
==========
2-
git-dag(1)
3-
==========
1+
=======
2+
git-dag
3+
=======
44

55
SYNOPSIS
66
========
7-
git dag [options] [<since>..<until>] [[--] [<path>...]]
7+
``git dag [options] [<revision-range>] [[--] [<path>...]]``
8+
89

910
DESCRIPTION
1011
===========
11-
`git-dag` is a powerful Git history visualizer.
12-
`git-dag` presents powerful `git log` features in a simple-to-use
13-
graphical interface.
12+
`git-dag` is an advanced Git history visualizer that presents ``git log``'s
13+
powerful features in an easy to use graphical interface.
14+
1415

1516
OPTIONS
1617
=======
18+
``<revision-range>``
19+
--------------------
20+
Show only commits in the specified revision range.
21+
When no ``<revision-range>`` is specified, it defaults to ``HEAD``
22+
(i.e. the whole history leading to the current commit).
23+
24+
``origin..HEAD`` specifies all the commits reachable from the current commit
25+
(i.e. ``HEAD``), but not from ``origin``.
26+
27+
For a complete list of ways to spell ``<revision-range>``, see the Specifying Ranges
28+
section of `gitrevisions(7) <https://git-scm.com/docs/gitrevisions>`_
29+
(``man gitrevisions``).
30+
1731

1832
``--prompt``
1933
------------
2034
Prompt for a Git repository instead of using the current directory.
2135

2236
``-r, --repo <path>``
2337
---------------------
24-
Run `git dag` on the git repository in `<path>`.
38+
Open the git repository located at ``<path>``.
2539
Defaults to the current directory.
2640

2741
``--version``
2842
-------------
29-
Print the `git dag` version and exit.
43+
Print the version number and exit.
3044

3145
``-h, --help``
3246
--------------
3347
Show usage and optional arguments.
3448

35-
Log Options
36-
===========
37-
The `Log` prompt allows you to pass arguments to `git log`.
49+
50+
Log Arguments
51+
=============
52+
The ``Log`` text field allows you to pass arguments to `git log`.
3853
This can be used to filter the displayed history, for example
3954
entering `main -- Makefile` will display only commits on the
4055
`main` branch that touch the `Makefile`.
4156

57+
The `Log` text field lets you interactively edit and replace the
58+
``[<revision-range>] [[--] [<path>...]]`` arguments that were initially
59+
specified on the command-line.
60+
4261
CONTEXT-MENU ACTIONS
4362
====================
4463
The right-click menu can be used to perform various actions.

share/doc/git-cola/hotkeys.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,17 @@
241241
<td>Show and hide tools<br>
242242
# is 1 for commit, 2 for status, 3 for diff, etc.</td>
243243
</tr>
244+
<tr>
245+
<td class="shortcut">Ctrl + Space</td>
246+
<td>:</td>
247+
<td>Display autocomplete options</td>
248+
</tr>
249+
<tr>
250+
<td class="shortcut">Ctrl + Shift + #</td>
251+
<td>:</td>
252+
<td>Show and hide tools<br>
253+
# is 1 for commit, 2 for status, 3 for diff, etc.</td>
254+
</tr>
244255
</table>
245256

246257
<!-- Remotes -->

share/doc/git-cola/hotkeys_de.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,11 @@
239239
<td>:</td>
240240
<td>Werkzeuge anzeigen und verstecken</td>
241241
</tr>
242+
<tr>
243+
<td class="shortcut">Ctrl + Space</td>
244+
<td>:</td>
245+
<td>Display autocomplete options</td>
246+
</tr>
242247
</table>
243248

244249
<!-- Diff -->

share/doc/git-cola/hotkeys_zh_CN.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,11 @@
238238
<td>:</td>
239239
<td>显示/隐藏工具</td>
240240
</tr>
241+
<tr>
242+
<td class="shortcut">Ctrl + Space</td>
243+
<td>:</td>
244+
<td>Display autocomplete options</td>
245+
</tr>
241246
</table>
242247

243248
<!-- Diff -->

share/doc/git-cola/hotkeys_zh_TW.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,11 @@
237237
<td>顯示或隱藏指定工具<br>
238238
對提交版本工具來說 # 為 1、對版控庫狀態工具來說 # 為 2、對內容差異工具來說 # 為 3,依此類推</td>
239239
</tr>
240+
<tr>
241+
<td class="shortcut">Ctrl + Space</td>
242+
<td>:</td>
243+
<td>Display autocomplete options</td>
244+
</tr>
240245
</table>
241246

242247
<!-- Diff -->

share/doc/git-cola/html/genindex.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Index &mdash; git-cola 4.4.1 documentation</title>
6+
<title>Index &mdash; Python 4.4.1 documentation</title>
77
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -29,7 +29,7 @@
2929

3030

3131
<a href="index.html" class="icon icon-home">
32-
git-cola
32+
Python
3333
</a>
3434
<div class="version">
3535
4.4.1
@@ -43,8 +43,8 @@
4343
</div>
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<ul>
46-
<li class="toctree-l1"><a class="reference internal" href="git-cola.html">git-cola(1)</a></li>
47-
<li class="toctree-l1"><a class="reference internal" href="git-dag.html">git-dag(1)</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="git-cola.html">git-cola</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="git-dag.html">git-dag</a></li>
4848
<li class="toctree-l1"><a class="reference internal" href="thanks.html">Thanks</a></li>
4949
</ul>
5050
<ul>
@@ -57,7 +57,7 @@
5757

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

6363
<div class="wy-nav-content">
@@ -89,7 +89,7 @@ <h1 id="index">Index</h1>
8989
<hr/>
9090

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

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

0 commit comments

Comments
 (0)