Difference between revisions of "Category talk:Developer Documentation"

From Alpine Linux
Jump to: navigation, search
(Created page with '= Developer Documentation = Documentation how to build and modify the Alpine distro. * Alpine Package Testing Suite * Alpine Configuration Framework Design (Why ACF is t...')
 
 
(64 intermediate revisions by 15 users not shown)
Line 1: Line 1:
= Developer Documentation =
+
[[Image:package_system.svg|right|link=]]
Documentation how to build and modify the Alpine distro.
+
 
 +
== Package management ==
 +
<!-- If you edit the following, please coordinate with Tutorials_and_Howtos#Post-Install and Installation#Post-Install.  Note that these three sections are not exact duplicates. -->
 +
* [[Alpine Linux package management|Package Management (apk)]] ''(How to add/remove packages on your Alpine)'' <!--
 +
  [[Alpine Linux package management#Local_Cache|How to enable APK caching]] -->  <!-- includes [[Local APK cache]] -->
 +
** [[Comparison with other distros]]
 +
** [[apk spec]]
 +
* [[Edge|Upgrading to Edge]]
 +
* [[Alpine local backup|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]]
 +
<!-- [[Replacing a package]] Obsolete? -->
 +
* [[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]]
 +
 
 +
== Init system ==
 +
* [[initramfs init]]
 +
* [[Alpine Linux Init System|Init System (OpenRC)]] ''(Configure a service to automatically launch at next reboot)''
 +
** [[Multiple Instances of Services]]
 +
* [[Writing Init Scripts]]
 +
 
 +
== Development ==
 +
=== Configuring your system ===
 +
* [[Edge|Upgrading to Edge]] <!-- Pkg and Dev and Installation -->
 +
 
 +
<!-- If you edit the following, please coordinate with Installation#Advanced.  Note that these two sections are not exact duplicates. -->
 +
* [[Setting up the build environment on HDD]] <!-- Dev and Installation -->
 +
<!-- [[Setting up the build environment 1.7]] Obsolete, only Dev -->
 +
** [[Creating_an_Alpine_package#Setup_your_system_and_account|Setup your system and account for building packages]]
 +
** [[Abuild_and_Helpers#abuild-keygen|Abuild-keygen]]
 +
 
 +
* [[Installing Alpine Linux in a chroot]] <!-- only Installation -->
 +
** [[Buildlab]] ''(Tool for creating and managing chroots)''
 +
* [[Install Alpine on LXC]]
 +
* Install Alpine on [[Install Alpine on VirtualBox|VirtualBox]], [[Install Alpine on VMware|VMware]], [[Install Alpine on coLinux|coLinux]], [[Qemu]], <!-- includes [[Install Alpine in Qemu]], [[Running Alpine in Qemu Live mode]], [[Running Alpine Linux As a QEMU networked Guest]] --> or [[Install Alpine on Amazon EC2|Amazon EC2]]
 +
 
 +
* [[Xen Dom0]] ''(Setting up Alpine as a dom0 for Xen hypervisor)''
 +
** [[Xen Dom0 on USB or SD]]
 +
** [[Create Alpine Linux PV DomU]]
 +
** [[Xen LiveCD]]
 +
 
 +
* [[Setting up a basic vserver]] <!-- only Installation -->
 +
* [[Setting up a compile vserver]] for official or for [[Setting up a compile vserver for third party packages|third party]] packages <!-- Dev and Installation -->
 +
<!-- [[Create an Alpine 1.9 vserver template]] -->
 +
 
 +
=== Building from source and creating packages ===
 +
 
 +
* [[Aports tree]] <!-- <== APKBUILD -->
 +
* [[Abuild and Helpers]] ''(Scripts for packaging)''
 +
  <!-- includes [[Abuild_and_Helpers#apkbuild-cpan|Apkbuild-cpan]] -->
 +
  <!-- includes [[Abuild_and_Helpers#apkbuild-pypi|Apkbuild-pypi]] -->
 +
  <!--
 +
  [[Abuild_and_Helpers#buildrepo|Buildrepo]]
 +
  [[Abuild_and_Helpers#abuild-sign|Abuild-sign]]
 +
  [[Abuild_and_Helpers#abuild-tar|Abuild-tar]]
 +
  [[Abuild_and_Helpers#abump|Abump]]
 +
  [[Abuild_helpers#apkgrel|Apkgrel]]
 +
  -->
 +
* [[Creating an Alpine package]]
 +
  <!-- includes [[Setup your system and account for building packages]] -->
 +
  <!-- includes [[Newapkbuild]]
 +
      To create the actual APKBUILD file, newapkbuild can give 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. -->
 +
  <!-- includes [[Local_APK_cache]] -->
 +
** [[Package policies]]
 +
** [[Package Maintainers]]
 +
* [[Custom Kernel]]
 +
* [[APKBUILD Reference]]
 +
* [[APKBUILD examples]]
 +
* [[Alpine package format]]
 +
* [[Apkindex format]]
 +
 
 +
 
 +
* [[Development using git]] <!-- includes [[Development using git:Configuration]] [[Development using git:Email]] -->
 +
** [[Development using git:Basic usage|Basic usage]]
 +
** [[Package Maintainers]]
 +
** [[Creating patches]]
 +
** [[Development using git:Developer repositories|Developer repositories]]
 +
** [[Development using git:Cgit|Cgit]]
 +
** [[Cgit|Another cgit page]]
 +
 
 +
=== Misc ===
 +
 
 +
* [[Alpine Package Testing Suite]] ''work in progress''
 +
* [[Alpine Release Testing Checklist]]
 +
* [[Running glibc programs]]
 +
* [[Alpine Source Map by boot sequence]]
 +
 
 +
== Alpine Configuration Framework ==
 +
{{Draft|Needs to be organized/consolidated.}}
  
* [[Alpine Package Testing Suite]]
 
 
* [[Alpine Configuration Framework Design]] (Why ACF is the way it is)
 
* [[Alpine Configuration Framework Design]] (Why ACF is the way it is)
* [[Development using git]]
 
* [[Installing Alpine on a virtual machine]]
 
 
* [[Writing User Documentation for ACF]]
 
* [[Writing User Documentation for ACF]]
 +
* [[ACF mvc.lua reference|mvc.lua reference]] - mvc.lua is the core of ACF
 +
* [[ACF mvc.lua example|mvc.lua example]] - build a simple (command-line) application
 +
* [[ACF acf www-controller.lua reference|acf www-controller reference]] - ACF www application functions
 +
* [[ACF acf www example|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
  
== Alpine 1.9.x build system ==
+
* [[ACF css]]
After Alpine 1.8 is released we will switch to a new build system. Those docs here below is for bulding packages in Alpine 1.9 and later.
+
* [[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]]
  
* [[Setting up the build environment]]
 
* [[Creating an Alpine package]]
 
* [[Creating_an_Alpine_1.9_iso]] (This page is experimental and might go away or move in the future)
 
  
== Obsolete docs ==
+
== Alpine-developed Utilities ==
* [[Setting up the build environment 1.7]]
+
* [[Alpine Wall]] - [[How-To Alpine Wall]] - [[Alpine Wall User's Guide]] ''(a new firewall management framework)''
* [[Newbie Guide to Building an apk]]
 
* [[Creating patches]]
 
  
== Misc. References ==
+
== Alpine Design Docs ==
Other useful references.
+
* [[Architecture]]
 +
* [[File Formats]]
  
* http://www.metoffice.gov.uk/research/nwp/external/fcm/doc/user_guide/working_practices.html - Some guidelines on use of Trac and SVN
+
[[Category:Development]]

Latest revision as of 15:49, 6 October 2019

Package system.svg

Package management

Init system

Development

Configuring your system

Building from source and creating packages


Misc

Alpine Configuration Framework

Underconstruction clock icon gray.svg
This material is work-in-progress ...

Needs to be organized/consolidated.
(Last edited by Nullbyte on 6 Oct 2019.)


Alpine-developed Utilities

Alpine Design Docs