Skip to content

doc : rebase #2742

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.

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 10 commits into from
Sep 16, 2016
Merged

doc : rebase #2742

merged 10 commits into from
Sep 16, 2016

Conversation

tacaswell
Copy link
Member

closes #2733

My writing probably needs a lot of editing.

@tacaswell
Copy link
Member Author

I have never liked origin for a remote name. Is origin your user github repo (which could make sense) or is in the upstream version which is the 'origin' of the the library.

To be fair, my use of 'github' for the user's repository is just as confusing.

@pelson
Copy link
Member

pelson commented Jan 20, 2014

FWIW numpy have also documented a similar thing: http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#rebasing-on-master

@tacaswell
Copy link
Member Author

@pelson I (humbly) like my version better because I include the output of the middle steps, but I will include a link.

@tacaswell
Copy link
Member Author

don't merge this, I am going to go through and update the rest of the git documentation as well (git is changing under us a bit in the way it deals with push).

I also plan to change origin -> github as a remote name everywhere.

@tacaswell
Copy link
Member Author

I am also going to remove the text about emailing diffs to the mailing list to bring our documentation into line with our practice (which seems to be to make PRs and then do the review in the PR).

@tacaswell tacaswell mentioned this pull request Feb 2, 2014
The first step is to make sure that your local copy of the upstream repository is
up-to-date::

$ git fetch upstream
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it pertinent a git checkout master before the git fetch upstream?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, fetch only copies commits it does not merge them into your branches. I am deeply suspicious of pull.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So am I: pull merges automatically, which is rarely what you want.

@fariza
Copy link
Member

fariza commented Feb 6, 2014

I didn't notice before, you are adding this text to doc/devel/coding_guide.rst I think it belongs to doc/devel/gitwash/development_workflow.rst It is not coding per se, it's github and more specifically git related.

Actually that link development_workflow is the reference for all of us newcomers and git virgins.

Just a little extra, the origin vs github name.
I prefer origin, when you look for documentation non related to matplotlib, in general everybody use origin representing your fork in github. And consistence with the rest of the documentation is more important than personal preferences (origin is used in gitwash stuff)

@fariza
Copy link
Member

fariza commented Mar 25, 2014

@tacaswell
For the requested review, please check my last comment.
In short my suggestions are:

  • Use origin instead of github
  • Belongs to development_workflow.rst and not to coding_guide.rst

@tacaswell
Copy link
Member Author

Sorry, this issue should have been tagged as needs revision, thanks for poking me on this.

@tacaswell tacaswell added the doc label Apr 17, 2014
@tacaswell tacaswell modified the milestones: v1.4.x, v1.4.0 Jul 9, 2014
@tacaswell
Copy link
Member Author

punted

considered bad form, but in this case it is very useful.

The following example assumes that the remote of _your_ github
repository is called `github` and the remote of the official
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rename github to origin: it is more standard.

@NelleV
Copy link
Member

NelleV commented Jul 11, 2014

I'll do a PR against your PR.

@@ -135,6 +135,149 @@ C/C++ extensions
docstrings, and the Numpydoc format is well understood in the
scientific Python community.

Rebasing a Pull Request
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably add the acronym (PR). It isn't defined anywhere, and is github jargon.

@tacaswell tacaswell modified the milestones: v1.4.0, v1.4.x Jul 12, 2014
@tacaswell
Copy link
Member Author

I think the only outstanding issues is my use of github vs origin for the users repo. I personally detest the use of origin as a remote name, but if consensus is to change it back I will.


$ git push --force github

which will _replace_ all of the commits under your branch on github
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub

@NelleV
Copy link
Member

NelleV commented Sep 16, 2016

I think you'll have to rebase onto master :)

@tacaswell tacaswell changed the base branch from master to v2.x September 16, 2016 03:37
@tacaswell tacaswell modified the milestones: 2.0.1 (next bug fix release), 2.1 (next point release) Sep 16, 2016
@tacaswell
Copy link
Member Author

Decided to try out the 'retarget branch' functionality.

@tacaswell
Copy link
Member Author

@QuLogic Is that better wording?

@QuLogic
Copy link
Member

QuLogic commented Sep 16, 2016

Looks reasonable.

@NelleV
Copy link
Member

NelleV commented Sep 16, 2016

Thanks!

@NelleV NelleV merged commit 0655bc5 into matplotlib:v2.x Sep 16, 2016
@tacaswell tacaswell deleted the rebase_doc branch September 16, 2016 05:10
@tacaswell
Copy link
Member Author

🎉 Excited to get this in after so long!

@QuLogic QuLogic modified the milestones: 2.0.1 (next bug fix release), 2.0 (style change major release) Dec 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants