Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Regenerate the gitwash docs. #8137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 26, 2017
Merged

Regenerate the gitwash docs. #8137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/devel/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
All documentation in the gitwash directory are automatically generated by running the gitwash_dumper.py
script in the project's root directory using the following parameters:

python gitwash_dumper.py doc/devel Matplotlib --repo-name=matplotlib --github-user=matplotlib \
--project-url=http://matplotlib.org \
--project-ml-url=https://mail.python.org/mailman/listinfo/matplotlib-devel

The script is hosted at https://raw.githubusercontent.com/matthew-brett/gitwash/master/gitwash_dumper.py.
For more information please visit https://github.com/matthew-brett/gitwash
Binary file added doc/devel/gitwash/branch_dropdown.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 56 additions & 14 deletions doc/devel/gitwash/configure_git.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. highlight:: bash

.. _configure-git:

===============
Expand All @@ -9,9 +11,12 @@
Overview
========

Your personal git_ configurations are saved in the ``.gitconfig`` file in
Your personal git configurations are saved in the ``.gitconfig`` file in
your home directory.
Here is an example ``.gitconfig`` file::

Here is an example ``.gitconfig`` file:

.. code-block:: none

[user]
name = Your Name
Expand All @@ -20,8 +25,8 @@ Here is an example ``.gitconfig`` file::
[alias]
ci = commit -a
co = checkout
st = status -a
stat = status -a
st = status
stat = status
br = branch
wdiff = diff --color-words

Expand All @@ -31,13 +36,6 @@ Here is an example ``.gitconfig`` file::
[merge]
summary = true

[apply]
whitespace = fix

[core]
autocrlf = input


You can edit this file directly or you can use the ``git config --global``
command::

Expand Down Expand Up @@ -69,7 +67,9 @@ line::
git config --global user.email [email protected]

This will write the settings into your git configuration file, which
should now contain a user section with your name and email::
should now contain a user section with your name and email:

.. code-block:: none

[user]
name = Your Name
Expand Down Expand Up @@ -97,7 +97,9 @@ The following ``git config --global`` commands::
git config --global alias.wdiff "diff --color-words"

will create an ``alias`` section in your ``.gitconfig`` file with contents
like this::
like this:

.. code-block:: none

[alias]
ci = commit -a
Expand All @@ -117,7 +119,9 @@ You may also want to make sure that your editor of choice is used ::
Merging
-------

To enforce summaries when doing merges (``~/.gitconfig`` file again)::
To enforce summaries when doing merges (``~/.gitconfig`` file again):

.. code-block:: none

[merge]
log = true
Expand All @@ -126,5 +130,43 @@ Or from the command line::

git config --global merge.log true

.. _fancy-log:

Fancy log output
----------------

This is a very nice alias to get a fancy log output; it should go in the
``alias`` section of your ``.gitconfig`` file:

.. code-block:: none

lg = log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)[%an]%Creset' --abbrev-commit --date=relative

You use the alias with::

git lg

and it gives graph / text output something like this (but with color!):

.. code-block:: none

* 6d8e1ee - (HEAD, origin/my-fancy-feature, my-fancy-feature) NF - a fancy file (45 minutes ago) [Matthew Brett]
* d304a73 - (origin/placeholder, placeholder) Merge pull request #48 from hhuuggoo/master (2 weeks ago) [Jonathan Terhorst]
|\
| * 4aff2a8 - fixed bug 35, and added a test in test_bugfixes (2 weeks ago) [Hugo]
|/
* a7ff2e5 - Added notes on discussion/proposal made during Data Array Summit. (2 weeks ago) [Corran Webster]
* 68f6752 - Initial implimentation of AxisIndexer - uses 'index_by' which needs to be changed to a call on an Axes object - this is all very sketchy right now. (2 weeks ago) [Corr
* 376adbd - Merge pull request #46 from terhorst/master (2 weeks ago) [Jonathan Terhorst]
|\
| * b605216 - updated joshu example to current api (3 weeks ago) [Jonathan Terhorst]
| * 2e991e8 - add testing for outer ufunc (3 weeks ago) [Jonathan Terhorst]
| * 7beda5a - prevent axis from throwing an exception if testing equality with non-axis object (3 weeks ago) [Jonathan Terhorst]
| * 65af65e - convert unit testing code to assertions (3 weeks ago) [Jonathan Terhorst]
| * 956fbab - Merge remote-tracking branch 'upstream/master' (3 weeks ago) [Jonathan Terhorst]
| |\
| |/

Thanks to Yury V. Zaytsev for posting it.

.. include:: links.inc
Loading