Sage Developer's Guide - Mirrors

CHAPTERONESAGE DEVELOPMENT PROCESSThis section is a concise overview of the Sage development process. In it, we will see how to make changes to the Sagesource code and communicate these changes back to the Sage project. If you are a beginner to Sage development, thisintroductory guide is here to help you become familiar with the Sage development process.Sage comes with a set of developer scripts, which help you with common interactions with the bug tracker (see TheSage Trac Server) and with handling revisions of your code. The developer scripts use the git distributed revisoncontrol system under the hood which you’ll have to install (see Setting Up Git), but you do not need to know anythingabout it (see Git the Hard Way only if you want to).Most of the commands in the following section will not work unless you have an account on the bug tracker. If youwant to contribute to Sage, it is a good idea to get an account now (see Obtaining an Account).We assume here that the sage executable of your development installation of Sage is in your PATH. If this is notthe case, you might have to replace sage by ./sage or /path/to/sage in the following. You can also use thedeveloper scripts from the Sage prompt. All commandline options to sage -dev are also available as methods ofthe dev object in a Sage session. That is, for example, to checkout a ticktet you can either run:[user@localhost]$ sage -dev checkout --ticket 1729On ticket #1729 with associated local branch "ticket/1729".# Use "sage --dev merge" to include another ticket/branch.# Use "sage --dev commit" to save changes into a new commit.in a terminal or, equivalently, within Sagesage: dev.checkout(1729)On ticket #1729 with associated local branch "ticket/1729".# Use "dev.merge()" to include another ticket/branch.# Use "dev.commit()" to save changes in a new commit.Note that the number sign # (a.k.a. hash or pound sign) is the comment marker for both the shell and Python. So ifyou were to input #1729, it will be interpreted as the comment “1729” and not passed to the development scripts.Always specify the ticket number as a plain number, without the number sign in front.Warning: During the transitional period it can happen that you end up on a branch where the developer scriptsare not available or outdated. If this is the case, i.e., if sage -dev does not work properly anymore, run:git pull git://trac.sagemath.org/sage.git mastersage -bThis will merge the latest version of the developer scripts with your current branch. After rebuilding the Sagelibrary, the dev scripts will work again.3