333. Adds explanation of command lines; tweaks format-patch line
* Adds explanation of command lines and their arguments (gullydwarf's suggestion). * Switched the ``git format-patch ...`` line from using -o patches to using --stdout. This creates a single patch file and is (probably) easier to deal with. * Fixed a typo. * Adds toc to top of mediagoblin chapter
This commit is contained in:
parent
4fd18da0a8
commit
f439193628
32
docs/git.rst
32
docs/git.rst
@ -82,8 +82,8 @@ How to send us your changes
|
|||||||
|
|
||||||
There are three ways to let us know how to get it:
|
There are three ways to let us know how to get it:
|
||||||
|
|
||||||
1. (preferred) **push changes to publicly available git clone and let
|
1. *(preferred)* **push changes to publicly available git clone and
|
||||||
us know where to find it**
|
let us know where to find it**
|
||||||
|
|
||||||
Push your feature/bugfix/issue branch to your publicly available
|
Push your feature/bugfix/issue branch to your publicly available
|
||||||
git clone and add a comment to the issue with the url for your
|
git clone and add a comment to the issue with the url for your
|
||||||
@ -93,14 +93,22 @@ There are three ways to let us know how to get it:
|
|||||||
|
|
||||||
Run::
|
Run::
|
||||||
|
|
||||||
git format-patch -o patches <remote>/master
|
git format-patch --stdout <remote>/master > issue_<number>.patch
|
||||||
|
|
||||||
Then tar up the newly created ``patches`` directory and attach the
|
``format-patch`` creates a patch of all the commits that are in
|
||||||
directory to the issue.
|
your branch that aren't in ``<remote>/master``. The ``--stdout``
|
||||||
|
flag causes all this output to go to stdout where it's redirected
|
||||||
|
to a file named ``issue_<number>.patch``. That file should be
|
||||||
|
based on the issue you're working with. For example,
|
||||||
|
``issue_42.patch`` is a good filename and ``issue_42_rev2.patch``
|
||||||
|
is good if you did a revision of it.
|
||||||
|
|
||||||
|
Having said all that, the filename isn't wildly important.
|
||||||
|
|
||||||
|
|
||||||
Example workflow
|
Example workflow
|
||||||
================
|
================
|
||||||
|
|
||||||
Here's an example workflow.
|
Here's an example workflow.
|
||||||
|
|
||||||
|
|
||||||
@ -124,20 +132,30 @@ Slartibartfast does the following:
|
|||||||
|
|
||||||
git fetch --all -p
|
git fetch --all -p
|
||||||
|
|
||||||
|
This tells ``git fetch`` to fetch all the recent data from all of
|
||||||
|
the remotes (``--all``) and prune any branches that have been
|
||||||
|
deleted in the remotes (``-p``).
|
||||||
|
|
||||||
2. Creates a branch from the tip of the MediaGoblin repository (the
|
2. Creates a branch from the tip of the MediaGoblin repository (the
|
||||||
remote is named ``gmg``) master branch called ``bug42_meaning_of_life``::
|
remote is named ``gmg``) master branch called ``bug42_meaning_of_life``::
|
||||||
|
|
||||||
git checkout -b bug42_meaning_of_life gmg/master
|
git checkout -b bug42_meaning_of_life gmg/master
|
||||||
|
|
||||||
|
This creates a new branch (``-b``) named ``bug42_meaning_of_life`` based
|
||||||
|
on the tip of the ``master`` branch of the remote named ``gmg`` and checks
|
||||||
|
it out.
|
||||||
|
|
||||||
3. Slartibartfast works hard on his changes in the ``bug42_meaning_of_life``
|
3. Slartibartfast works hard on his changes in the ``bug42_meaning_of_life``
|
||||||
branch. When done, he wants to notify us that he has made changes
|
branch. When done, he wants to notify us that he has made changes
|
||||||
he wants us to see.
|
he wants us to see.
|
||||||
|
|
||||||
4. Slartibartfast pushes his changes to his clone (the remote is named
|
4. Slartibartfast pushes his changes to his clone::
|
||||||
``origin``)::
|
|
||||||
|
|
||||||
git push origin bug42_meaning_of_life --set-upstream
|
git push origin bug42_meaning_of_life --set-upstream
|
||||||
|
|
||||||
|
This pushes the changes in the ``bug42_meaning_of_life`` branch to the
|
||||||
|
remote named ``origin``.
|
||||||
|
|
||||||
5. Slartibartfast adds a comment to issue 42 with the url for his
|
5. Slartibartfast adds a comment to issue 42 with the url for his
|
||||||
repository and the name of the branch he put the code in. He also
|
repository and the name of the branch he put the code in. He also
|
||||||
explains what he did and why it addresses the issue.
|
explains what he did and why it addresses the issue.
|
||||||
|
@ -2,6 +2,10 @@
|
|||||||
GNU MediaGoblin
|
GNU MediaGoblin
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
.. contents:: Sections
|
||||||
|
:local:
|
||||||
|
|
||||||
|
|
||||||
What is GNU MediaGoblin
|
What is GNU MediaGoblin
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user