This page contains developer-specific documentation.
1 - Coding Style
-
1.1 File Structure
+
1.1 C
+
1.1.1 File Structure
Files should follow this format:
Header comment, including program name and LICENSE
@@ -42,7 +43,7 @@
Note that function declarations should be defined in a separate header, ex:
#include "project_name.h"
Indentations should be a single tab and be equal to 8 characters for better readability.
-
1.2 Functions
+
1.1.2 Functions
Functions should have their return type on one line, their name and parameters one line down, and the bracket one line under the name and arguments.
Example:
CODE: Proper function formatting in C
@@ -54,7 +55,7 @@
}
-
1.3 Example Program
+
1.1.3 Example Program
FILE: prog.c
#include <stdio.h>
@@ -83,6 +84,31 @@
#endif
+
1.1.4 common.h
+
For large programs which include many header files, it is perfectly acceptable to define these includes in a separate header and then include that in each file.
A system profile describes your base system, including C library, architecture, SELinux support, multilib support, etc.
3 - Included programs
3.1 gpkg
-
'gpkg' is the program most users will be interacting with. It handles the downloading, installation, and logging of packages.
+
gpkg is the program most users will be interacting with. It handles the downloading, installation, and logging of packages.
3.2 syspkg
-
'syspkg' is like 'gpkg', except it operates on the system index, rather than the local index. End users should not use this unless instructed to.
+
syspkg is like gpkg, except it operates on the system index, rather than the local index. End users should not use this unless instructed to.
3.3 glist
-
'glist' lists all installed packages, allowing the user to filter by name.
+
glist lists all installed packages, allowing the user to filter by name.
3.4 gquery
-
'gquery' queries information on a package.
-
3.5 glacier-mkprofile
-
'glacier-mkprofile' makes changes to the system-wide profile. Users should not interact with this unless needed.
+
gquery queries information on a package.
+
3.5 gpc
+
gpc checks if the syntax of a package is correct. This can be used to troubleshoot a package refusing to install, but is mainly intended for package developers.
+
3.6 glacier-mkprofile
+
glacier-mkprofile makes changes to the system-wide profile. Users should not interact with this unless needed.
+
3.7 glacier-update-pkdgb
+
glacier-update-pkgdb syncs the local package database with the remote server. This command should be run periodically to ensure you have the most up-to-date packages.
4 - Frontends
Frontends, or wrappers, may provide additional functionality to Glacier.
WARNING:
@@ -54,36 +58,35 @@
5 - Merging packages
5.1 Using gpkg
To merge a package from a repository:
- (root)# gpkg -f repo/pkg
-
For instance, to install 'vim' in the 'world' repository:
Using 'syspkg' is not recommended for end users because all changes to the global package index will be overwritten when pulling a new update.
-
If you understand these risks, and wish to use 'syspkg' anyways, you are acknowledging that things may break.
-
To merge a package from a repository:
- (root)# syspkg -f repo/pkg
+
Using syspkg is not recommended for end users because all changes to the global package index will be overwritten when pulling a new update.
+
If you understand these risks, and wish to use syspkg anyways, you are acknowledging that things may break.
+
To merge a package:
+ (root)# syspkg -f pkg
6 - Updating packages
6.1 Introduction
-
When merging a package into any index, the package file is retained in said index. This provides most information needed to keep track of the package, however, when updating, an updated package file will need to be downloaded. Old package files will be retained as 'pkgname.old'.
+
When merging a package into any index, the package file is retained in said index. This provides most information needed to keep track of the package, however, when updating, an updated package file will need to be downloaded. Old package files will be retained as pkgname.old.
6.2 Using gpkg
To update a package:
- (root)# gpkg -u repo/pkg
+ (root)# gpkg -u pkg
6.3 Using syspkg
-
As mentioned above, 'syspkg' is intended for system development, and NOT for end users.
-
However, 'syspkg -u' has some use cases for end users. These include:
+
As mentioned above, syspkg is intended for system development, and NOT for end users.
+
However, syspkg -u has some use cases for end users. These include:
Updating a system program WITHOUT pulling a new release from Git
When removing a package, the package info file is moved from the appropriate index to /tmp, and saved as 'pkgname.rm'. This means it will be wiped after the next reboot.
+
When removing a package, the package info file is moved from the appropriate index to /tmp, and saved as pkgname.rm. This means it will be wiped after the next reboot.
7.2 Using gpkg
To remove a package:
(root)# gpkg -x pkg
-
Note that no repository name was provided. It is not required, as no files will be downloaded during the removal process.
If a package is a dependency for another, you will be shown the following error:
[x] Could not remove (package_name): is a dependency for (package_name)
7.3 Using syspkg
@@ -98,20 +101,20 @@
Patching packages is the act of editing a package file to change compile options, optimizations, etc. It is very useful if used correctly.
The officially tested and verified method for patching is as follows:
-
Download the package file with 'gpkg -d'
+
Download the package file with gpkg -d
Edit the package file with a text editor of your choice
-
Install the locally modified package with 'gpkg -fl pkg'
+
Install the locally modified package with gpkg -fl pkg
8.2 Custom package repository
If Glacier's standard package repository is not sufficient, you can use a custom one.
WARNING:
-
Ensure the repository you wish to migrate to supports your system profile. For example, if your profile is 'x86-musl', the new repository should offer packages compatible with 'x86-musl'.
+
Ensure the repository you wish to migrate to supports your system profile. For example, if your profile is x86-musl, the new repository should offer packages compatible with x86-musl.
Errors will occur if this is not taken into account.
To use a custom repository once, to merge a package:
Documentation for Everest is formatted in a specific way. This page explains how a page is formatted, and what certain things mean, in as much detail as possible.
2 - Cards
2.1 Introduction
-
Most Everest documentation pages will contain some type of a "card". Put simply, these are small sections that contain file contents, kernel configurations, warnings, notes, etc. There are 6 types of cards:
+
Most Everest documentation pages will contain some type of a "card". Put simply, these are small containers that contain file contents, kernel configurations, warnings, notes, etc. There are 6 types of cards:
2.2 Note
This card is the most simple. It contains a note on a certain section. They are usually not required to read, but contain important information.
Chapters are typically the largest sections on a given page. The topics they cover are very broad. Each chapter contains its own sections.
+
A chapter header is large, bold, has a colored sidebar, and is denoted by its number.
+
3.2 Sections
+
Sections are nested within chapters, and typically pertain to more specific topics related to a chapter.
+
A section header is bold, and is denoted by the number of the chapter it is nested under, followed by that section's number.
+
3.3 Subsections
+
Subsections are nested within sections, and usually contain very specific topics pertaining to a section (and chapter at large). Sometimes, a page does not use subsections at all.
+
A subsection header is italic, and is denoted by the number of the chapter it is nested under, followed by the number of the section it is nested under, followed by that subsection's number.