Commit 4066f229 authored by Frank's avatar Frank 🏃
Browse files

Add configuration docs

parent 717e6a27
.. _configuration:
Configuration
=============
To configure ``git-open`` you may need to set some ``git config`` options.
You can use ``--global`` to set across all repositories, instead of just the current one.
..code: bash
git config [--global] option value
Configuring which remote to open
--------------------------------
If there is only one remote, ``git-open`` always opens that.
Otherwize ``git-open`` opens the remote named ``origin``, but you may want to override this behavior.
When you fork a project and add a remote named ``upstream`` you often want that ``upstream`` to be opened rather than your fork.
To accomplish this, you can set the ``open.default.remote`` within your project:
..code: bash
git config open.default.remote upstream
......@@ -4,8 +4,9 @@ Welcome to git-open documentation
*********************************
.. toctree::
:maxdepth: 2
:maxdepth: 2
synopsis.rst
description.rst
options.rst
synopsis.rst
description.rst
options.rst
configuration.rst
......@@ -4,6 +4,8 @@ Welcome to git-open documentation
*********************************
.. toctree::
:maxdepth: 2
:maxdepth: 2
git-open.1.rst
description.rst
options.rst
configuration.rst
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment