Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 Ind

[Top of Book] [Contents] [Next Chapter]

The GAP 4 Development Manual

Administrating the GAP Project

2015

The GAP Group
Email: support@gap-system.org
Homepage: https://www.gap-system.org

Abstract

In this development manual we collect documentation of various tasks needed for the further development, maintenance and distribution of GAP.

Some sections provide practical howto's and check lists for tasks like, e.g.: commiting changes, testing, wrapping archives, compiling documentation.

Other sections document certain conventions which are followed by the active members of The GAP Group. Some examples: there are several mailing lists which are used for different purposes; there is a mechanism how larger changes to the GAP system should be announced and discussed among the developers before they are commited, called proposals; there is a concept of modules where parts of the GAP system are assigned to specified maintainers.

Copyright

2005-2015, The GAP Group

Contents

1 Structure of the GAP distribution

1.1 Kernel, library, documentation, package interface, development part

1.2 The directories of the GAP distribution and repository

2 Preparing GAP Releases

2.1 Committing changes for the next minor or major release

2.1-1 Adding changes to the release branch
2.1-2 Document your changes

2.2 Wrapping Archives for a Release or Update

  2.2-1 What you need to start
  2.2-2 Before the actual wrapping
  2.2-3 Wrapping the archives for the GAP source distribution
  2.2-4 Compiling on Windows with Cygwin

2.3 Releasing a new version

3 The GAP kernel programming

3.1 Overview of the GAP kernel

3.2 "Hello World" example

3.3 Structure of the GAP kernel

3.4 Garbage collection in GAP

3.4-1 GASMAN
3.4-2 GASMAN Interface

3.6 Objects and API

  3.6-1 Immediate Integers and FFEs
  3.6-2 Arithmetics
  3.6-3 Functions
  3.6-4 Lists
  3.6-5 Data objects

3.7 Rules of Kernel Programming

  3.7-1 Three golden rules
  3.7-2 Common kernel traps
  3.7-3 One More Bit of GASMAN interface

3.8 The GAP compiler

  3.8-1 Compiling GAP Code
  3.8-2 Suitability for Compilation
  3.8-3 Compiling Library Code

3.9 Global Variables

3.9-1 Global variables
3.9-2 Tracking global variables

3.10 The Kernel Module Structure and interface

  3.10-1 The Kernel Module Structure
  3.10-2 The Kernel Module Interface
  3.10-3 Sequences of Events
  3.10-4 Saving a Workspace
  3.10-5 Excerpts from InitKernel from integer.c
  3.10-6 Commentary
  3.10-7 Other Similar Functions
  3.10-8 Importing from the Library
  3.10-9 InitKernel
  3.10-10 initLibrary and postRestore

4 Maintaining the GAP kernel and library

4.1 Debugging the GAP Kernel

5 Maintaining the GAP documentation

5.1 The source of the GAP documentation

5.2 How to compile the GAP manuals from the sources

6 Testing GAP

6.1 .tst-files

6.2 Checking examples in the main manuals

6.3 Tests for packages

6.4 Checking references and cross-references of manuals

6.5 Detecting potential naming conflicts

6.6 The standard test suite

6.7 Test evaluation

6.8 Test Issues for Releases

6.9 Open items concerning tests

7 Version control using Git

7.1 Introduction

7.1-1 Using Git

8 Distributing packages via the GAP sites

9 Maintaining the GAP website

9.2 Getting started

9.6 The web server in St Andrews

9.7 Installation on the web server

  9.7-1 Needed ingredients
  9.7-2 Installation procedure
  9.7-3 Installing updated versions

9.8 The GAP manuals on the web pages

9.9 The GAP packages on the web pages

9.10 The search engine on the web pages

9.11 The GAP bibliography

9.12 The sitemap

9.13 The GAP forum archive

10 Hints and conventions for writing GAP programs

10.1 Naming conventions

[Top of Book] [Contents] [Next Chapter]

Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 Ind

generated by GAPDoc2HTML