mirror of
https://github.com/SebastianWendel/nixpkgs.git
synced 2024-09-21 12:59:04 +02:00
sage: update readme to reflect trac->gh migration
This commit is contained in:
parent
96f13f9193
commit
b7b53aec79
|
@ -10,7 +10,7 @@ First you should find out which change to nixpkgs is at fault (if you don't alre
|
|||
|
||||
If the build broke as a result of a package update, try those solutions in order:
|
||||
|
||||
- search the [sage trac](https://trac.sagemath.org/) for keywords like "Upgrade <package>". Maybe somebody has already proposed a patch that fixes the issue. You can then add a `fetchpatch` to `sage-src.nix`.
|
||||
- search the [sage GitHub repo](https://github.com/sagemath/sage) for keywords like "Upgrade <package>". Maybe somebody has already proposed a patch that fixes the issue. You can then add a `fetchpatch` to `sage-src.nix`.
|
||||
|
||||
- check if [gentoo](https://github.com/cschwan/sage-on-gentoo/tree/master/sci-mathematics/sage), [debian](https://salsa.debian.org/science-team/sagemath/tree/master/debian) or [arch linux](https://git.archlinux.org/svntogit/community.git/tree/trunk?h=packages/sagemath) already solved the problem. You can then again add a `fetchpatch` to `sage-src.nix`. If applicable you should also [propose the patch upstream](#proposing-a-sage-patch).
|
||||
|
||||
|
@ -19,7 +19,7 @@ If the build broke as a result of a package update, try those solutions in order
|
|||
```
|
||||
[user@localhost ~]$ git clone https://github.com/sagemath/sage.git
|
||||
[user@localhost ~]$ cd sage
|
||||
[user@localhost sage]$ git checkout 8.2 # substitute the relevant version here
|
||||
[user@localhost sage]$ git checkout 9.8 # substitute the relevant version here
|
||||
```
|
||||
|
||||
Then make the needed changes and generate a patch with `git diff`:
|
||||
|
@ -29,42 +29,10 @@ Then make the needed changes and generate a patch with `git diff`:
|
|||
[user@localhost ~]$ git diff -u > /path/to/nixpkgs/pkgs/applications/science/math/sage/patches/name-of-patch.patch
|
||||
```
|
||||
|
||||
Now just add the patch to `sage-src.nix` and test your changes. If they fix the problem, [propose them upstream](#proposing-a-sage-patch) and add a link to the trac ticket.
|
||||
Now just add the patch to `sage-src.nix` and test your changes. If they fix the problem, submit a PR upstream (refer to sages [Developer's Guide](http://doc.sagemath.org/html/en/developer/index.html) for further details).
|
||||
|
||||
- pin the package version in `default.nix` and add a note that explains why that is necessary.
|
||||
|
||||
|
||||
## Proposing a sage patch
|
||||
|
||||
You can [login the sage trac using GitHub](https://trac.sagemath.org/login). Your username will then be `gh-<your-github-name>`. The only other way is to request a trac account via email. After that refer to [git the hard way](http://doc.sagemath.org/html/en/developer/manual_git.html#chapter-manual-git) in the sage documentation. The "easy way" requires a non-GitHub account (requested via email) and a special tool. The "hard way" is really not all that hard if you're a bit familiar with git.
|
||||
|
||||
Here's the gist, assuming you want to use ssh key authentication. First, [add your public ssh key](https://trac.sagemath.org/prefs/sshkeys). Then:
|
||||
|
||||
```
|
||||
[user@localhost ~]$ git clone https://github.com/sagemath/sage.git
|
||||
[user@localhost ~]$ cd sage
|
||||
[user@localhost sage]$ git remote add trac git@trac.sagemath.org:sage.git -t master
|
||||
[user@localhost sage]$ git checkout -b u/gh-<your-github-username>/<your-branch-name> develop
|
||||
[user@localhost sage]$ <make changes>
|
||||
[user@localhost sage]$ git add .
|
||||
[user@localhost sage]$ git commit
|
||||
[user@localhost sage]$ git show # review your changes
|
||||
[user@localhost sage]$ git push --set-upstream trac u/gh-<your-github-username>/<your-branch-name>
|
||||
```
|
||||
|
||||
You now created a branch on the trac server (you *must* follow the naming scheme as you only have push access to branches with the `u/gh-<your-github-username>/` prefix).
|
||||
Now you can [create a new trac ticket](https://trac.sagemath.org/newticket).
|
||||
- Write a description of the change
|
||||
- set the type and component as appropriate
|
||||
- write your real name in the "Authors" field
|
||||
- write `u/gh-<your-github-username>/<your-branch-name>` in the "Branch" field
|
||||
- click "Create ticket"
|
||||
- click "Modify" on the top right of your ticket (for some reason you can only change the ticket status after you have created it)
|
||||
- set the ticket status from `new` to `needs_review`
|
||||
- click "Save changes"
|
||||
|
||||
Refer to sages [Developer's Guide](http://doc.sagemath.org/html/en/developer/index.html) for further details.
|
||||
|
||||
## I want to update sage
|
||||
|
||||
You'll need to change the `version` field in `sage-src.nix`. Afterwards just try to build and let nix tell you which patches no longer apply (hopefully because they were adopted upstream). Remove those.
|
||||
|
@ -74,5 +42,5 @@ If the problem is not obvious, you can try to first update sage to an intermedia
|
|||
|
||||
## Well, that didn't help!
|
||||
|
||||
If you couldn't fix the problem, create a GitHub issue on the nixpkgs repo and ping @timokau (or whoever is listed in the `maintainers` list of the sage package).
|
||||
If you couldn't fix the problem, create a GitHub issue on the nixpkgs repo and ping the sage maintainers (as listed in the sage package).
|
||||
Describe what you did and why it didn't work. Afterwards it would be great if you help the next guy out and improve this documentation!
|
||||
|
|
Loading…
Reference in a new issue