Contribution Guidelines (Carbs Linux User Manual)

From 821fda61da4ab4d596d1399f21fa6cc9b1e51444 Mon Sep 17 00:00:00 2001 From: Cem Keylan Date: Wed, 9 Sep 2020 19:16:07 +0300 Subject: update --- src/docs/Changing-Init-Program.html | 4 +- src/docs/Configuring-Init.html | 8 +- src/docs/Contribution-Guidelines.html | 112 +++++++++++++++++++++ src/docs/GN0010.html | 43 ++++++++ src/docs/GN0011.html | 43 ++++++++ src/docs/GN0012.html | 43 ++++++++ src/docs/GN0013.html | 43 ++++++++ src/docs/Init-System.html | 6 +- src/docs/Package-Manager.html | 2 +- src/docs/Packaging-System.html | 16 ++- src/docs/SH0010.html | 43 ++++++++ src/docs/SH0020.html | 43 ++++++++ src/docs/SH0030.html | 43 ++++++++ src/docs/SH0040.html | 43 ++++++++ src/docs/SH0041.html | 43 ++++++++ src/docs/SH0042.html | 43 ++++++++ src/docs/SH0043.html | 43 ++++++++ src/docs/SH0050.html | 43 ++++++++ ...ng-up-an-rsync-repository-for-distribution.html | 3 +- src/docs/index.html | 23 +++-- src/news.xml | 2 +- src/rss.xml | 2 +- 22 files changed, 666 insertions(+), 28 deletions(-) create mode 100644 src/docs/Contribution-Guidelines.html create mode 100644 src/docs/GN0010.html create mode 100644 src/docs/GN0011.html create mode 100644 src/docs/GN0012.html create mode 100644 src/docs/GN0013.html create mode 100644 src/docs/SH0010.html create mode 100644 src/docs/SH0020.html create mode 100644 src/docs/SH0030.html create mode 100644 src/docs/SH0040.html create mode 100644 src/docs/SH0041.html create mode 100644 src/docs/SH0042.html create mode 100644 src/docs/SH0043.html create mode 100644 src/docs/SH0050.html (limited to 'src') diff --git a/src/docs/Changing-Init-Program.html b/src/docs/Changing-Init-Program.html index 60bf1b3..35e648f 100644 --- a/src/docs/Changing-Init-Program.html +++ b/src/docs/Changing-Init-Program.html @@ -44,7 +44,7 @@ ul.no-bullet {list-style: none} Previous: Configuring Init, Up: Init System

3.2 Changing Init Program

4.2 Changing Init Program

By default, Carbs Linux comes preinstalled with busybox-init, but this can easily be replaced without any issues. Currently, available init systems are: @@ -65,7 +65,7 @@ $ cpt a runit /usr/bin/poweroff $ cpt a runit /usr/bin/reboot -

3.2.1 Rebooting after changing Init

4.2.1 Rebooting after changing Init

After switching init systems, your running init system may not accept the new poweroff commands. You will need to reboot/poweroff using the running init’s diff --git a/src/docs/Configuring-Init.html b/src/docs/Configuring-Init.html index e90cd74..22a8195 100644 --- a/src/docs/Configuring-Init.html +++ b/src/docs/Configuring-Init.html @@ -45,7 +45,7 @@ ul.no-bullet {list-style: none} Next: Changing Init Program, Up: Init System

3.1 Configuring Init

4.1 Configuring Init

There are three ways you can change the behaviour of the init system. Those are:

@@ -55,7 +55,7 @@ Next: Changing Ini

Init Hooks

3.1.1 Kernel Command Line

4.1.1 Kernel Command Line

On GRUB, you can edit the kernel command line parameters, which will be parsed as variables on the init system. Not all of the parameters will be acted upon, @@ -80,14 +80,14 @@ quiet=1 quiet, will be used by the init system to change the behaviour of the startup.

3.1.2 `/etc/init/rc.conf` file

4.1.2 `/etc/init/rc.conf` file

However, the kernel command line isn’t the only place to set your boot parameters. You can specify variables here as well, although note that the kernel command line always gets the priority for these variables since they can be set just before boot.

3.1.3 Init Hooks

4.1.3 Init Hooks

Init hooks are for custom personal commands that the user may want to add to alter their boot. These can be used to load kernel modules, modify interfaces, diff --git a/src/docs/Contribution-Guidelines.html b/src/docs/Contribution-Guidelines.html new file mode 100644 index 0000000..c47cd34 --- /dev/null +++ b/src/docs/Contribution-Guidelines.html @@ -0,0 +1,112 @@ + + + + + + +Contribution Guidelines (Carbs Linux User Manual) + + + + + + + + + + + + + + + + +

3 Contribution Guidelines

+ +

Thanks for taking your time to contribute! To maintain stylistic behaviour +throughout the repositories, one must adhere to these guidelines. Exceptions and +changes may occur with good reasoning. +

3.1 General Conventions – GN

+ +

These apply to each and every file on the repositories. +

Try to keep the file readable. [GN0010] +
- Characters on a line shouldn’t exceed 100 characters excluding indentation. [GN0011] +
- Make sure you don’t have code commented out during commit. Uncomment them +or remove them completely. [GN0012] +
- Do not add comments following the code, add them to the top of the code. It +makes it harder to read, and lines longer. [GN0013] +Here is an example: +
  +
```
# Good way of commenting.
+your code goes here
+
+your code goes here  # Avoid this way of commenting.
+
```
  +
+

+ +

3.2 Shell conventions – SH

+ +

Shell is central to Carbs Linux projects. Most of the tools and packages are +written in POSIX sh. +

Use 4 spaces for indentation, instead of tabs. [SH0010] +
Make sure you don’t use bash-specific code. [SH0020] +
Make sure you lint your code with shellcheck and if you are new to +POSIX sh, use checkbashisms. [SH0030] +
Don’t spawn new processes if you don’t absolutely need to, especially during +string manipulation. [SH0040] +
- Never use a program for text manupilation that isn’t defined in the POSIX +standard. This includes gawk and perl. [SH0041] +
- Instead of $(basename $file), use ${file##*}. [SH0042] +
- Instead of $(dirname $file), use ${file%/*}. [SH0043] +
+
+
```
# This is the same thing as basename /path/to/test.asc .asc
+
+$ file=/path/to/test.asc file=${file##*/} file=${file%.asc}
+$ echo $file
+test
+
```
+
Instead of backticks, use $(..). [SH0050] +

+ + + + + + diff --git a/src/docs/GN0010.html b/src/docs/GN0010.html new file mode 100644 index 0000000..a50b64d --- /dev/null +++ b/src/docs/GN0010.html @@ -0,0 +1,43 @@ + + + + + + + +GN0010 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at GN0010.

+ diff --git a/src/docs/GN0011.html b/src/docs/GN0011.html new file mode 100644 index 0000000..053df11 --- /dev/null +++ b/src/docs/GN0011.html @@ -0,0 +1,43 @@ + + + + + + + +GN0011 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at GN0011.

+ diff --git a/src/docs/GN0012.html b/src/docs/GN0012.html new file mode 100644 index 0000000..2b2346f --- /dev/null +++ b/src/docs/GN0012.html @@ -0,0 +1,43 @@ + + + + + + + +GN0012 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at GN0012.

+ diff --git a/src/docs/GN0013.html b/src/docs/GN0013.html new file mode 100644 index 0000000..e2edbf6 --- /dev/null +++ b/src/docs/GN0013.html @@ -0,0 +1,43 @@ + + + + + + + +GN0013 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at GN0013.

+ diff --git a/src/docs/Init-System.html b/src/docs/Init-System.html index cf596dd..00174d4 100644 --- a/src/docs/Init-System.html +++ b/src/docs/Init-System.html @@ -16,7 +16,7 @@ Licensed under Gnu Free Documentation License. --> - + + + + + + + + +

The node you are looking for is at SH0010.

+ diff --git a/src/docs/SH0020.html b/src/docs/SH0020.html new file mode 100644 index 0000000..2d6c3e3 --- /dev/null +++ b/src/docs/SH0020.html @@ -0,0 +1,43 @@ + + + + + + + +SH0020 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0020.

+ diff --git a/src/docs/SH0030.html b/src/docs/SH0030.html new file mode 100644 index 0000000..412dad4 --- /dev/null +++ b/src/docs/SH0030.html @@ -0,0 +1,43 @@ + + + + + + + +SH0030 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0030.

+ diff --git a/src/docs/SH0040.html b/src/docs/SH0040.html new file mode 100644 index 0000000..cc95a09 --- /dev/null +++ b/src/docs/SH0040.html @@ -0,0 +1,43 @@ + + + + + + + +SH0040 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0040.

+ diff --git a/src/docs/SH0041.html b/src/docs/SH0041.html new file mode 100644 index 0000000..b174e61 --- /dev/null +++ b/src/docs/SH0041.html @@ -0,0 +1,43 @@ + + + + + + + +SH0041 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0041.

+ diff --git a/src/docs/SH0042.html b/src/docs/SH0042.html new file mode 100644 index 0000000..9593e0c --- /dev/null +++ b/src/docs/SH0042.html @@ -0,0 +1,43 @@ + + + + + + + +SH0042 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0042.

+ diff --git a/src/docs/SH0043.html b/src/docs/SH0043.html new file mode 100644 index 0000000..5b3eda2 --- /dev/null +++ b/src/docs/SH0043.html @@ -0,0 +1,43 @@ + + + + + + + +SH0043 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0043.

+ diff --git a/src/docs/SH0050.html b/src/docs/SH0050.html new file mode 100644 index 0000000..b009263 --- /dev/null +++ b/src/docs/SH0050.html @@ -0,0 +1,43 @@ + + + + + + + +SH0050 (Carbs Linux User Manual) + + + + + + + + + + + + + + +

The node you are looking for is at SH0050.

+ diff --git a/src/docs/Setting-up-an-rsync-repository-for-distribution.html b/src/docs/Setting-up-an-rsync-repository-for-distribution.html index 2262723..1008488 100644 --- a/src/docs/Setting-up-an-rsync-repository-for-distribution.html +++ b/src/docs/Setting-up-an-rsync-repository-for-distribution.html @@ -15,7 +15,7 @@ Licensed under Gnu Free Documentation License. --> - +