Goto Chapter: Top 1 2 3 4 5 6 7 8 9 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.: committing 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 committed, called proposals; there is a concept of modules where parts of the GAP system are assigned to specified maintainers.

Copyright

© (2005-this year) 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 The GAP kernel programming

2.1 Overview of the GAP kernel

2.2 "Hello World" example

2.3 Structure of the GAP kernel

2.4 Garbage collection in GAP

  2.4-1 GASMAN
  2.4-2 GASMAN Interface
  2.4-3 The GASMAN Interface for Weak Pointer Objects

2.6 Objects and API

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

2.7 Rules of Kernel Programming

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

2.8 The GAP compiler

2.8-1 Compiling GAP Code
2.8-2 Suitability for Compilation

2.9 Global Variables

2.9-1 Global variables
2.9-2 Tracking global variables

2.10 The Kernel Module Structure and interface

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

3 Maintaining the GAP kernel and library

3.1 Debugging the GAP Kernel

4 Maintaining the GAP documentation

4.1 The source of the GAP documentation

4.2 How to compile the GAP manuals from the sources

5 Testing GAP

5.1 .tst-files

5.2 Checking examples in the main manuals

5.3 Tests for packages

5.4 Checking references and cross-references of manuals

5.5 Detecting potential naming conflicts

5.6 The standard test suite

5.7 Test evaluation

5.8 Test Issues for Releases

5.9 Open items concerning tests

6 Version control using Git

6.1 Introduction

6.1-1 Using Git

7 Distributing packages via the GAP sites

8 Maintaining the GAP website

8.2 Getting started

8.4 The web server in St Andrews

8.5 Installation on the web server

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

8.6 The GAP manuals on the web pages

8.7 The GAP packages on the web pages

8.8 The GAP forum archive

9 Hints and conventions for writing GAP programs

9.1 Naming conventions

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

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

generated by GAPDoc2HTML