User:Dubiousjim/Developer Documentation

This material is work-in-progress ... Do not follow instructions here until this notice is removed. (Last edited by Dubiousjim on 25 Mar 2012.)

Package management

• Package Management (apk) (How to add/remove packages on your Alpine)
• Upgrading to Edge
• Alpine local backup (lbu) (Permanently store your modifications in case your box needs reboot)
  • Back Up a Flash Memory Installation
  • Manually editing a existing apkovl
• How to setup a Alpine Linux mirror
• How to use xdelta and download only differential update files
• How to make a custom ISO image
  • Burning ISOs
• Comparison - Comparison with Gentoo and Debian - [1] [2]

Init system

• Init System (OpenRC) (Configure a service to automatically boot at next reboot)
  • Multiple Instances of Services
• Writing Init Scripts

Development

Configuring your system

• Upgrading to Edge
• Setup your system and account for building packages

• Setting up the build environment on HDD

• Installing Alpine Linux in a chroot

• Install Alpine on VirtualBox, VMware, coLinux, or Qemu

• Xen Dom0 Setting up Alpine as a dom0 for Xen hypervisor
  • Xen Dom0 on USB or SD
  • Create Alpine Linux PV DomU

• Setting up a basic vserver
• Setting up a compile vserver for official or for third party packages

Creating packages/building from source

• Creating an Alpine package
• Description of the aports tree
• APKBUILD --> Aports tree
• Abuild

• Description of the abuild tree

I think this document should be deleted. It does not provide any useful information at all.
* You don't need check out abuild from git to be able to build packages. (using an official release of abuild is higly recommended)
* abuild.mk have been replaced with alpine-iso.git long time ago.
* the term 'build environment' made sense when we built alpine from gentoo. Now the 'build environment' is a normal alpine install + apk add alpine-sdk.
* The doc mention nothing about how to use abuild to build packages, not even it mention that you need to do 'make && sudo make install' 
In short this doc provides no relevant info. I vote for removing it and instead write an how to use abuild doc or similar. --Ncopa 14:45, 6 July 2011 (UTC) 
DJ: should at least be merged into Abuild

The abuild package provides scripts you need when creating packages for Alpine Linux. The abuild and its friends are installed automatically along with the alpine-sdk package.
    apk add alpine-sdk
http://git.alpinelinux.org/cgit/abuild.git/tree/ always contains the lastest version of the scripts, example-files, and makefiles.

Helpers
{{:Abuild-keygen}}
{{:Abuild-sign}}
{{:Abuild-tar}}
{{:Abump}}
{{:Apkgrel}}
{{:Abuild}}

APKBUILD templates
To create the actual APKBUILD file newapkbuild can serve you a template to start with. It will create a directory with the given package name, place an example/template APKBUILD file to the given directory, and fill some variables if those are provided.
{{:Newapkbuild}}
{{:Apkbuild-cpan}}
{{:Apkbuild-pypi}}

Tools
[[Buildlab]]
{{:Buildrepo}}
cmp-apks-iso
devbuild
initramfs-init

• Abuild-keygen

   Abuild tree (inclusion) (← links)
   Creating an Alpine package (← links)
   Setup your system and account for building packages (← links)

• Abuild-sign

   Abuild tree (inclusion) (← links)

• • Creating keys for package signing

   Apkindex format (← links)

• Abuild-tar

   Abuild tree (inclusion) (← links)

• Abump

   Abuild tree (inclusion) (← links)

• Apkgrel

   Abuild tree (inclusion) (← links)

• Abuild again
• Newapkbuild

   Creating an Alpine package (inclusion) (← links)
   Abuild tree (inclusion) (← links)

• Apkbuild-cpan

   Abuild tree (inclusion) (← links)

• Apkbuild-pypi

   Abuild tree (inclusion) (← links)

• Buildlab

   Abuild tree (← links)

• Buildrepo

   Abuild tree (inclusion) (← links)

• Alpine package format (no links)
• Apkindex format
• Package policies

   Creating an Alpine package (← links)
   Developer Documentation (← links)

• Package Maintainers (no links)
• APKBUILD Reference

   Creating an Alpine package (← links)
   Aports tree (← links)
   Developer Documentation (← links)
   Setup your system and account for building packages (← links)

Git

• Development using git (Development using git:Configuration) (Development using git:Email)

   Creating patches (← links)
   Creating an Alpine package (← links)
   Developer Documentation (← links)
   Alpine Linux:Contribute (← links)
   Setup your system and account for building packages (← links)

• • Development using git:Basic usage

• • Creating patches

   Development using git (← links)
   Creating an Alpine package (← links)

• • Development using git:Developer repositories

   Development using git (← links)
   Development using git:Cgit (← links)

• • Development using git:Cgit

   Development using git (← links)
   Publish developer repositories on cgit (redirect page) (← links) 

Examples

• APKBUILD examples

   Creating an Alpine package (← links)
   APKBUILD Reference (← links

• • APKBUILD examples:Simple
  • APKBUILD examples:Subpackages
  • APKBUILD examples:Multiple Subpackages
  • APKBUILD examples:Special Subpackages Doc

-test subpackage

• • APKBUILD examples:Special Subpackages Examples
  • APKBUILD examples:Special Subpackages Languages
  • APKBUILD examples:ACF
  • APKBUILD examples:Perl
  • APKBUILD examples:Php
  • APKBUILD examples:Python
  • APKBUILD examples:Ruby
  • Lua
  • OCaml
  • Haskell
  • Chicken Scheme

Misc

• Alpine Package Testing Suite Work in progress
• Alpine Release Testing Checklist

Alpine Configuration Framework

This material is work-in-progress ... Needs to be organized/consolidated. (Last edited by Dubiousjim on 25 Mar 2012.)

• Alpine Configuration Framework Design (Why ACF is the way it is)
• Writing User Documentation for ACF
• mvc.lua reference - mvc.lua is the core of ACF
• mvc.lua example - build a simple (command-line) application
• acf www-controller reference - ACF www application functions
• acf www-controller example - webify the above examples
• ACF how to write - Step by step howto for writing acfs
• ACF core principles - Things that are standard across the application
• LuaPosix - Documentation for the Lua Posix functions
• ACF Libraries - Document the libraries and common functions
• Writing ACF Views - Guide for writing a view
• Writing ACF Controllers - Guide for writing a controller
• Writing ACF Models - Guide for writing a model

• ACF css
• ACF packages
• APKBUILD examples:ACF
• Apk.lua
• Changing passwords for ACF
• Generating SSL certs with ACF
• Generating SSL certs with ACF 1.9
• Getting started with ACF development
• Managing ACF

Alpine-developed Utilities

• Alpine Wall (proposed firewall management framework)

Other (shouldn't be in Development?)

• Running glibc programs
• Setting up trac wiki
• Redmine