sage: update readme to reflect trac->gh migration

+4 -36
+4 -36
pkgs/applications/science/math/sage/README.md
··· 10 10 11 11 If the build broke as a result of a package update, try those solutions in order: 12 12 13 - - 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`. 13 + - 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`. 14 14 15 15 - 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). 16 16 ··· 19 19 ``` 20 20 [user@localhost ~]$ git clone https://github.com/sagemath/sage.git 21 21 [user@localhost ~]$ cd sage 22 - [user@localhost sage]$ git checkout 8.2 # substitute the relevant version here 22 + [user@localhost sage]$ git checkout 9.8 # substitute the relevant version here 23 23 ``` 24 24 25 25 Then make the needed changes and generate a patch with `git diff`: ··· 29 29 [user@localhost ~]$ git diff -u > /path/to/nixpkgs/pkgs/applications/science/math/sage/patches/name-of-patch.patch 30 30 ``` 31 31 32 - 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. 32 + 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). 33 33 34 34 - pin the package version in `default.nix` and add a note that explains why that is necessary. 35 35 36 - 37 - ## Proposing a sage patch 38 - 39 - 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. 40 - 41 - 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: 42 - 43 - ``` 44 - [user@localhost ~]$ git clone https://github.com/sagemath/sage.git 45 - [user@localhost ~]$ cd sage 46 - [user@localhost sage]$ git remote add trac git@trac.sagemath.org:sage.git -t master 47 - [user@localhost sage]$ git checkout -b u/gh-<your-github-username>/<your-branch-name> develop 48 - [user@localhost sage]$ <make changes> 49 - [user@localhost sage]$ git add . 50 - [user@localhost sage]$ git commit 51 - [user@localhost sage]$ git show # review your changes 52 - [user@localhost sage]$ git push --set-upstream trac u/gh-<your-github-username>/<your-branch-name> 53 - ``` 54 - 55 - 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). 56 - Now you can [create a new trac ticket](https://trac.sagemath.org/newticket). 57 - - Write a description of the change 58 - - set the type and component as appropriate 59 - - write your real name in the "Authors" field 60 - - write `u/gh-<your-github-username>/<your-branch-name>` in the "Branch" field 61 - - click "Create ticket" 62 - - click "Modify" on the top right of your ticket (for some reason you can only change the ticket status after you have created it) 63 - - set the ticket status from `new` to `needs_review` 64 - - click "Save changes" 65 - 66 - Refer to sages [Developer's Guide](http://doc.sagemath.org/html/en/developer/index.html) for further details. 67 - 68 36 ## I want to update sage 69 37 70 38 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 42 75 43 ## Well, that didn't help! 76 44 77 - 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). 45 + 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). 78 46 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!