summaryrefslogtreecommitdiff
path: root/doc/devel
diff options
context:
space:
mode:
authorarokem <arokem@berkeley.edu>2010-05-25 15:50:20 -0700
committerarokem <arokem@berkeley.edu>2010-05-25 15:50:20 -0700
commitfa6001f8f4055b74d97b70f1258896a578de39f7 (patch)
treed5326fffaf5426184c3eb1cf3adaa63101463690 /doc/devel
parent5ae3f04a6c0a09b74e8db1e6e34f4eddd988eb76 (diff)
Committed gitwash related stuff again, after making some fixes
Diffstat (limited to 'doc/devel')
-rw-r--r--doc/devel/development_workflow.rst28
-rw-r--r--doc/devel/following_latest.rst10
-rw-r--r--doc/devel/forking_hell.rst10
-rw-r--r--doc/devel/git_intro.rst4
-rw-r--r--doc/devel/git_links.txt5
-rw-r--r--doc/devel/index.rst2
-rw-r--r--doc/devel/patching.rst20
-rw-r--r--doc/devel/set_up_fork.rst26
8 files changed, 52 insertions, 53 deletions
diff --git a/doc/devel/development_workflow.rst b/doc/devel/development_workflow.rst
index f9da2d8..8dc2a0a 100644
--- a/doc/devel/development_workflow.rst
+++ b/doc/devel/development_workflow.rst
@@ -4,7 +4,7 @@
Development workflow
====================
-You already have your own forked copy of the nitime_ repository, by
+You already have your own forked copy of the Nitime_ repository, by
following :ref:`forking`, :ref:`set-up-fork`, and you have configured
git_ by following :ref:`configure-git`.
@@ -12,8 +12,8 @@ Workflow summary
================
* Keep your ``master`` branch clean of edits that have not been merged
- to the main nitime_ development repo. Your ``master`` then will follow
- the main nitime_ repository.
+ to the main Nitime_ development repo. Your ``master`` then will follow
+ the main Nitime_ repository.
* Start a new *feature branch* for each set of edits that you do.
* If you can avoid it, try not to merge other branches into your feature
branch while you are working.
@@ -33,7 +33,7 @@ Making a new feature branch
git checkout my-new-feature
Generally, you will want to keep this also on your public github_ fork
-of nitime_. To do this, you `git push`_ this new branch up to your github_
+of Nitime_. To do this, you `git push`_ this new branch up to your github_
repo. Generally (if you followed the instructions in these pages, and
by default), git will have a link to your github_ repo, called
``origin``. You push up to your own repo on github_ with::
@@ -91,7 +91,7 @@ In more detail
Asking for code review
======================
-#. Go to your repo URL - e.g. ``http://github.com/your-user-name/fperez``.
+#. Go to your repo URL - e.g. ``http://github.com/your-user-name/nitime``.
#. Click on the *Branch list* button:
.. image:: branch_list.png
@@ -104,9 +104,9 @@ Asking for code review
compare. Usually these will be ``master`` and ``my-new-feature``
(where that is your feature branch name).
#. At this point you should get a nice summary of the changes. Copy the
- URL for this, and post it to the `nitime mailing list`_, asking for
+ URL for this, and post it to the `Nitime mailing list`_, asking for
review. The URL will look something like:
- ``http://github.com/your-user-name/fperez/compare/master...my-new-feature``.
+ ``http://github.com/your-user-name/nitime/compare/master...my-new-feature``.
There's an example at
http://github.com/matthew-brett/nipy/compare/master...find-install-data
See: http://github.com/blog/612-introducing-github-compare-view for
@@ -125,19 +125,19 @@ Asking for your changes to be merged with the main repo
When you are ready to ask for the merge of your code:
#. Go to the URL of your forked repo, say
- ``http://github.com/your-user-name/fperez.git``.
+ ``http://github.com/your-user-name/nitime.git``.
#. Click on the 'Pull request' button:
.. image:: pull_button.png
- Enter a message; we suggest you select only ``nitime`` as the
- recipient. The message will go to the `nitime mailing list`_. Please
+ Enter a message; we suggest you select only ``Nitime`` as the
+ recipient. The message will go to the `Nitime mailing list`_. Please
feel free to add others from the list as you like.
Merging from trunk
==================
-This updates your code from the upstream `nitime github`_ repo.
+This updates your code from the upstream `Nitime github`_ repo.
Overview
--------
@@ -192,10 +192,10 @@ If you want to work on some stuff with other people, where you are all
committing into the same repository, or even the same branch, then just
share it via github_.
-First fork nitime into your account, as from :ref:`forking`.
+First fork Nitime into your account, as from :ref:`forking`.
Then, go to your forked repository github page, say
-``http://github.com/your-user-name/fperez``
+``http://github.com/your-user-name/nitime``
Click on the 'Admin' button, and add anyone else to the repo as a
collaborator:
@@ -204,7 +204,7 @@ collaborator:
Now all those people can do::
- git clone git@githhub.com:your-user-name/fperez.git
+ git clone git@githhub.com:your-user-name/nitime.git
Remember that links starting with ``git@`` use the ssh protocol and are
read-write; links starting with ``git://`` are read-only.
diff --git a/doc/devel/following_latest.rst b/doc/devel/following_latest.rst
index a9d674a..2142278 100644
--- a/doc/devel/following_latest.rst
+++ b/doc/devel/following_latest.rst
@@ -5,7 +5,7 @@
=============================
These are the instructions if you just want to follow the latest
-*nitime* source, but you don't need to do any development for now.
+*Nitime* source, but you don't need to do any development for now.
The steps are:
@@ -18,19 +18,19 @@ Get the local copy of the code
From the command line::
- git clone git://github.com/fperez/fperez.git
+ git clone git://github.com/fperez/nitime.git
-You now have a copy of the code tree in the new ``fperez`` directory.
+You now have a copy of the code tree in the new ``nitime`` directory.
Updating the code
=================
From time to time you may want to pull down the latest code. Do this with::
- cd fperez
+ cd nitime
git pull
-The tree in ``fperez`` will now have the latest changes from the initial
+The tree in ``nitime`` will now have the latest changes from the initial
repository.
.. include:: git_links.txt
diff --git a/doc/devel/forking_hell.rst b/doc/devel/forking_hell.rst
index 6b45699..0a12aa0 100644
--- a/doc/devel/forking_hell.rst
+++ b/doc/devel/forking_hell.rst
@@ -1,13 +1,13 @@
.. _forking:
==========================================
-Making your own copy (fork) of nitime
+Making your own copy (fork) of Nitime
==========================================
You need to do this only once. The instructions here are very similar
to the instructions at http://help.github.com/forking/ - please see that
page for more detail. We're repeating some of it here just to give the
-specifics for the nitime_ project, and to suggest some default names.
+specifics for the Nitime_ project, and to suggest some default names.
Set up and configure a github_ account
======================================
@@ -17,17 +17,17 @@ If you don't have a github_ account, go to the github_ page, and make one.
You then need to configure your account to allow write access - see the
``Generating SSH keys`` help on `github help`_.
-Create your own forked copy of nitime_
+Create your own forked copy of Nitime_
=========================================
#. Log into your github_ account.
-#. Go to the nitime_ github home at `nitime github`_.
+#. Go to the Nitime_ github home at `Nitime github`_.
#. Click on the *fork* button:
.. image:: forking_button.png
Now, after a short pause and some 'Hardcore forking action', you
- should find yourself at the home page for your own forked copy of nitime_.
+ should find yourself at the home page for your own forked copy of Nitime_.
.. include:: git_links.txt
diff --git a/doc/devel/git_intro.rst b/doc/devel/git_intro.rst
index df319c8..f59009c 100644
--- a/doc/devel/git_intro.rst
+++ b/doc/devel/git_intro.rst
@@ -2,11 +2,11 @@
Introduction
==============
-These pages describe a git_ and github_ workflow for the nitime_
+These pages describe a git_ and github_ workflow for the Nitime_
project.
There are several different workflows here, for different ways of
-working with *nitime*.
+working with *Nitime*.
This is not a comprehensive git_ reference, it's just a workflow for our
own project. It's tailored to the github_ hosting service. You may well
diff --git a/doc/devel/git_links.txt b/doc/devel/git_links.txt
index 81c446b..e58449f 100644
--- a/doc/devel/git_links.txt
+++ b/doc/devel/git_links.txt
@@ -8,9 +8,8 @@
__not_case_sensitive__, so only one target definition is needed for
nipy, NIPY, Nipy, etc...
-.. nitime placeholders
-.. _nitime: http://nipy.sourceforge.net/nitime/
-.. _`nitime github`: http://github.com/fperez/nitime
+.. _nitime: http://nipy.org/nitime
+.. _`nitime github`: http://github.com/fperez/nitime/
.. _`nitime mailing list`: http://projects.scipy.org/mailman/listinfo/nipy-devel
.. nipy
diff --git a/doc/devel/index.rst b/doc/devel/index.rst
index e6e783e..0eaa05a 100644
--- a/doc/devel/index.rst
+++ b/doc/devel/index.rst
@@ -1,6 +1,6 @@
.. _using-git:
-Working with *nitime* source code
+Working with *Nitime* source code
======================================
Contents:
diff --git a/doc/devel/patching.rst b/doc/devel/patching.rst
index 05c322d..3b361b8 100644
--- a/doc/devel/patching.rst
+++ b/doc/devel/patching.rst
@@ -2,7 +2,7 @@
Making a patch
================
-You've discovered a bug or something else you want to change in nitime_ - excellent!
+You've discovered a bug or something else you want to change in Nitime_ - excellent!
You've worked out a way to fix it - even better!
@@ -27,9 +27,9 @@ Overview
git config --global user.email you@yourdomain.example.com
git config --global user.name "Your Name Comes Here"
# get the repository if you don't have it
- git clone git://github.com/fperez/fperez.git
+ git clone git://github.com/fperez/nitime.git
# make a branch for your patching
- cd fperez
+ cd nitime
git branch the-fix-im-thinking-of
git checkout the-fix-im-thinking-of
# hack, hack, hack
@@ -42,7 +42,7 @@ Overview
# make the patch files
git format-patch -M -C master
-Then, send the generated patch files to the `nitime mailing list`_ - where we will thank you warmly.
+Then, send the generated patch files to the `Nitime mailing list`_ - where we will thank you warmly.
In detail
---------
@@ -52,10 +52,10 @@ In detail
git config --global user.email you@yourdomain.example.com
git config --global user.name "Your Name Comes Here"
-#. If you don't already have one, clone a copy of the nitime_ repository::
+#. If you don't already have one, clone a copy of the Nitime_ repository::
- git clone git://github.com/fperez/fperez.git
- cd fperez
+ git clone git://github.com/fperez/nitime.git
+ cd nitime
#. Make a 'feature branch'. This will be where you work on your bug
fix. It's nice and safe and leaves you with access to an unmodified
@@ -92,7 +92,7 @@ In detail
0001-BF-added-tests-for-Funny-bug.patch
0002-BF-added-fix-for-Funny-bug.patch
- Send these files to the `nitime mailing list`_.
+ Send these files to the `Nitime mailing list`_.
When you are done, to switch back to the main copy of the code, just
return to the ``master`` branch::
@@ -106,7 +106,7 @@ If you find you have done some patches, and you have one or more feature
branches, you will probably want to switch to development mode. You can
do this with the repository you have.
-Fork the nitime_ repository on github_ - :ref:`forking`. Then::
+Fork the Nitime_ repository on github_ - :ref:`forking`. Then::
# checkout and refresh master branch from main repo
git checkout master
@@ -114,7 +114,7 @@ Fork the nitime_ repository on github_ - :ref:`forking`. Then::
# rename pointer to main repository to 'upstream'
git remote rename origin upstream
# point your repo to default read / write to your fork on github
- git remote add origin git@github.com:your-user-name/fperez.git
+ git remote add origin git@github.com:your-user-name/nitime.git
# push up any branches you've made and want to keep
git push origin the-fix-im-thinking-of
diff --git a/doc/devel/set_up_fork.rst b/doc/devel/set_up_fork.rst
index f2a42e7..2c472b7 100644
--- a/doc/devel/set_up_fork.rst
+++ b/doc/devel/set_up_fork.rst
@@ -11,9 +11,9 @@ Overview
::
- git clone git@github.com/your-user-name/fperez.git
- cd fperez
- git remote add upstream git://github.com/fperez/fperez.git
+ git clone git@github.com/your-user-name/nitime.git
+ cd nitime
+ git remote add upstream git://github.com/fperez/nitime.git
In detail
=========
@@ -22,8 +22,8 @@ Clone your fork
---------------
#. Clone your fork to the local computer with ``git clone
- git@github.com:your-user-name/fperez.git``
-#. Investigate. Change directory to your new repo: ``cd fperez``. Then
+ git@github.com:your-user-name/nitime.git``
+#. Investigate. Change directory to your new repo: ``cd nitime``. Then
``git branch -a`` to show you all branches. You'll get something
like::
@@ -35,7 +35,7 @@ Clone your fork
What remote repository is ``remote/origin``? Try ``git remote -v`` to
see the URLs for the remote. They will point to your github_ fork.
- Now you want to connect to the upstream `nitime github`_ repository, so
+ Now you want to connect to the upstream `Nitime github`_ repository, so
you can merge in changes from trunk.
.. _linking-to-upstream:
@@ -45,11 +45,11 @@ Linking your repository to the upstream repo
::
- cd fperez
- git remote add upstream git://github.com/fperez/fperez.git
+ cd nitime
+ git remote add upstream git://github.com/fperez/nitime.git
``upstream`` here is just the arbitrary name we're using to refer to the
-main nitime_ repository at `nitime github`_.
+main Nitime_ repository at `Nitime github`_.
Note that we've used ``git://`` for the URL rather than ``git@``. The
``git://`` URL is read only. This means we that we can't accidentally
@@ -59,10 +59,10 @@ use it to merge into our own code.
Just for your own satisfaction, show yourself that you now have a new
'remote', with ``git remote -v show``, giving you something like::
- upstream git://github.com/fperez/fperez.git (fetch)
- upstream git://github.com/fperez/fperez.git (push)
- origin git@github.com:your-user-name/fperez.git (fetch)
- origin git@github.com:your-user-name/fperez.git (push)
+ upstream git://github.com/fperez/nitime.git (fetch)
+ upstream git://github.com/fperez/nitime.git (push)
+ origin git@github.com:your-user-name/nitime.git (fetch)
+ origin git@github.com:your-user-name/nitime.git (push)
.. include:: git_links.txt