-
Notifications
You must be signed in to change notification settings - Fork 2
/
carbslinux.txt
1677 lines (1262 loc) · 55.9 KB
/
carbslinux.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
_________________________
CARBS LINUX USER MANUAL
Cem Keylan
_________________________
Table of Contents
_________________
1. Copying
2. Installation
.. 1. Preparing Environment
..... 1. Download
..... 2. Signature verification
..... 3. Extracting the tarball
.. 2. Chroot
..... 1. Setting up repositories
..... 2. Updating packages
..... 3. Installing packages
..... 4. Essential Software
..... 5. Obtaining the documentation
.. 3. System Configuration
..... 1. Configuring hostname
..... 2. Hosts file
..... 3. Creating a user
.. 4. Kernel
..... 1. Obtaining the kernel sources
..... 2. Kernel dependencies
..... 3. Building the kernel
.. 5. Making your system bootable
..... 1. Bootloader
..... 2. Init scripts
..... 3. Fstab
.. 6. Post-installation
..... 1. IRC
..... 2. KISS repositories
3. Software
.. 1. Init System
..... 1. Configuring Init
..... 2. Changing Init Program
.. 2. Wayland
..... 1. Enabling the Wayland repository
..... 2. Switching from Xorg
..... 3. Installing a Compositor
4. Contribution Guidelines
.. 1. Conventions
..... 1. Shell Conventions
..... 2. Repository Conventions
.. 2. Contributing to the Community repository
.. 3. Sending Patches
..... 1. Git Patches
..... 2. Fossil Patches
5. GNU Free Documentation License
This is the full documentation of [Carbs Linux], from the details of the
distribution, installation, to the package manager. It is not yet
complete.
You can build and install the 'info' package in order to view this documentation
with the info reader. It is divided into sections and easier to read.
[Carbs Linux] <https://carbslinux.org>
1 Copying
=========
Copyright (c) 2020-2024 Cem Keylan
Permission is granted to copy, distribute and/or modify
this document under the terms of the GNU Free
Documentation License, Version 1.3 or any later version
published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts and no
Back-Cover Texts. A copy of the license is included in
the section entitled "GNU Free Documentation License."
2 Installation
==============
These are the step-by-step instructions for installing Carbs Linux. It
can be acquired as plain-text to be viewed offline with a pager from
<https://carbslinux.org/install.txt>.
,----
| curl -sL https://carbslinux.org/install.txt | less
`----
.. 1. Preparing Environment
..... 1. Download
..... 2. Signature verification
..... 3. Extracting the tarball
.. 2. Chroot
..... 1. Setting up repositories
..... 2. Updating packages
..... 3. Installing packages
..... 4. Essential Software
..... 5. Obtaining the documentation
.. 3. System Configuration
..... 1. Configuring hostname
..... 2. Hosts file
..... 3. Creating a user
.. 4. Kernel
..... 1. Obtaining the kernel sources
..... 2. Kernel dependencies
..... 3. Building the kernel
.. 5. Making your system bootable
..... 1. Bootloader
..... 2. Init scripts
..... 3. Fstab
.. 6. Post-installation
..... 1. IRC
..... 2. KISS repositories
2.1 Preparing Environment
~~~~~~~~~~~~~~~~~~~~~~~~~
To install Carbs Linux, you will need a Live Linux ISO. For that
purpose, you can obtain a Gentoo or Void Linux live image. You can
follow their instructions to boot and setup your network.
You will need the following programs in order to install Carbs Linux:
- tar
- wget
- xz
- some form of base utilities (coreutils, sbase, busybox, etc.)
Rest of these instructions will assume that you have set all of these
up, and will continue on that point.
2.1.1 Download
--------------
First, we need to download the rootfs tarball. You can do the
following in order to obtain the rootfs. If you are using an i686
machine, replace the `x86_64' with `i686'. We are setting this in a
URL variable so that we don't have to write it every time.
,----
| URL=https://dl.carbslinux.org/releases/x86_64
| wget $URL/carbs-rootfs.tar.xz.sha256
| sha256sum -c carbs-rootfs.tar.xz.sha256
`----
2.1.2 Signature verification
----------------------------
It is highly recommended to verify the signature of the tarball. You
will need the OpenBSD tool `signify(1)' for this. Many distributions
provide a package for it, if you are using a Carbs Linux host, you can
also install the package `otools' which provides `signify'. Download
the signature first.
,----
| wget $URL/carbs-rootfs.tar.xz.sig
`----
The signature file should say something similar to
,----
| untrusted comment: verify with carbslinux-2023.02.pub
| RWTe38zmx+iyuKEL5T84MJ5Y24jqenkTtQLJxbaMzOBS/NkGVl5J+Vn2B6vTV/gJK7LYBPS+IOXV5sEf+YLGCMcBYAGHCcP4xQ8=
`----
Grab the key (which probably should be the latest one) that is written
on the file from <https://dl.carbslinux.org/keys/> so you can verify
the signature. The latest Signify public key is also available on the
[package repository], so you can check the validity of the public key
from multiple locations, or just copy paste that portion to a file and
use that instead.
,----
| PUBKEY=carbslinux-2023.02.pub
| wget https://dl.carbslinux.org/keys/$PUBKEY
`----
You can now verify the distribution tarball with signify.
,----
| signify -V -m carbs-rootfs.tar.xz -p $PUBKEY
`----
If everything went alright, this should output:
,----
| Signature Verified
`----
[package repository] <https://git.carbslinux.org/repository>
2.1.3 Extracting the tarball
----------------------------
You will need to extract the tarball to your desired location. For
partitioning, you can follow [this guide]. This will assume that you
will be mounting your root partition to `/mnt'.
,----
| mount /dev/sdx1 /mnt
| tar xf carbs-rootfs.tar.xz -C /mnt
`----
[this guide] <https://wiki.archlinux.org/index.php/Partitioning>
2.2 Chroot
~~~~~~~~~~
Chroot into Carbs Linux by running the chroot helper inside the
rootfs!
,----
| /mnt/bin/cpt-chroot /mnt
`----
2.2.1 Setting up repositories
-----------------------------
Newest tarballs do not come with repositories, so you will need to
manually obtain them, and set your `CPT_PATH' environment
variable. Carbs Linux repositories can either be obtained by `git' or
`rsync'. While rsync repositories are overall faster and smaller, git
offers the whole history of the repository and a means to manipulate
your repository as you like it. If you want to obtain the git
repository, you will need to install `git' itself.
The following guide will assume that you put the repositories into
`~/repos/' directory, but you can put the repositories into any
directory you want. So go ahead and create that directory:
,----
| mkdir -p $HOME/repos
`----
* 2.2.1.1 Obtaining from git
Carbs Linux git repositories can be found both from the main server
and GitHub (mirror). Here are both their repository links. You can
clone any of them.
- <https://git.carbslinux.org/repository>
- <https://git.sr.ht/~carbslinux/repository>
,----
| git clone git://git.carbslinux.org/repository $HOME/repos/carbs
`----
* 2.2.1.2 Obtaining from rsync
Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In
order to obtain it, run the following:
,----
| rsync -avc rsync://vaylin.carbslinux.org/repo $HOME/repos/carbs
`----
* 2.2.1.3 Making the package manager use the repositories
In your shell's configuration file, or in your `~/.profile' file, add
the following lines:
,----
| CPT_PATH=$HOME/repos/carbs/core
| CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra
| CPT_PATH=$CPT_PATH:$HOME/repos/carbs/wayland
| CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community
| export CPT_PATH
`----
2.2.2 Updating packages
-----------------------
It is good practice to make sure your system is up to date, especially
before building new packages. If there is an update for the package
manager you will need to update twice.
,----
| cpt-update && cpt-update
`----
2.2.3 Installing packages
-------------------------
Since you are operating on a really small base, you might need to
build and install new programs to extend the functionality of your
system. In order to build and install packages new packages in Carbs,
you need to execute the following. "Package" is not actually a package
and is given as an example.
,----
| cpt-build package
| cpt-install package
`----
2.2.4 Essential Software
------------------------
Here is a small list of software that you might want to have on your
system as you are setting up. You might want to check the *Software*
section in the full documentation to learn more about other packaged
software.
*BOOTLOADERS*
- efibootmgr
- grub
*FILESYSTEMS*
- e2fsprogs
- dosfstools
- ntfs-3g
*NETWORKING*
- dhcpcd
- wpa_supplicant
*TEXT EDITORS*
- nano
- vim
*DOCUMENTATION*
- carbs-docs
- man-pages
- man-pages-posix
2.2.5 Obtaining the documentation
---------------------------------
All the documentation for Carbs Linux can be found on a single info
manual to be viewed offline. You can obtain either `texinfo' or the
`info' packages in order to view the documentation.
,----
| # Install the documentation.
| cpt b carbs-docs && cpt i carbs-docs
|
| # Install either texinfo or the info package. We will be installing standalone info
| # as it doesn't need perl.
| cpt b info && cpt i info
|
| # You can then run info and navigate through the documentation.
| info carbslinux
`----
2.3 System Configuration
~~~~~~~~~~~~~~~~~~~~~~~~
After you have finished installing some extra packages, you can
configure your system to your liking.
2.3.1 Configuring hostname
--------------------------
You might want to add a hostname, especially in a networked
environment. Your hostname will default to 'carbslinux' unless you set
this.
,----
| echo your-hostname > /etc/hostname
`----
2.3.2 Hosts file
----------------
You can edit your /etc/hosts file, which is the static lookup table
for host names. By default, there are two entries for localhost which
are OKAY. You can replace the 'localhost' part of these entries to
your hostname.
,----
| 127.0.0.1 localhost.localdomain localhost
| ::1 localhost.localdomain localhost ip6-localhost
`----
2.3.3 Creating a user
---------------------
Creating a new user is not strictly necessary, but it is highly
recommended. Especially for building packages, it is the safest
option to create an unprivileged user and using `doas' for doing
operations that require `root' privileges. The code block below
describes how to create a user (named `foo'), add them to the wheel
group, and to give doas permissions to the wheel group
,----
| # Create the new user
| adduser foo
|
| # Add the user to the wheel group
| addgroup foo wheel
|
| # Give root permission to the wheel group using doas
| echo permit persist :wheel >> /etc/doas.conf
`----
You are also advised to take a look at the doas configuration file and
the manual page of doas.
After you are finished you can switch to the new user by running
,----
| su foo
`----
2.4 Kernel
~~~~~~~~~~
Kernel isn't managed under the main repositories, even though you
could package one for your personal use. Here is an [example kernel
package], which you will need to reconfigure for your specific setup
if you want to make use of it.
[example kernel package]
<https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux>
2.4.1 Obtaining the kernel sources
----------------------------------
You can visit the <https://kernel.org> website to choose a kernel that
you want to install. Though only the latest stable and longterm (LTS)
versions are supported. Note that kernel releases are quite rapid, and
the version below is likely outdated, so don't run it verbatim.
,----
| # Download the kernel and extract it
| wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.19.4.tar.xz
| tar xJf linux-5.19.4.tar.xz
|
| # Change directory into the kernel sources
| cd linux-5.19.4
`----
*NOTE:* If you want to validate the kernel signature, install the
`gnupg2' package, and follow the instructions provided at
<https://kernel.org/category/signatures.html>.
2.4.2 Kernel dependencies
-------------------------
In order to compile the kernel you will need to install some
dependencies. You will need `libelf', and `bison' to compile the
kernel. If you want to configure using the menu interface you will
also need `ncurses'.
,----
| # The package manager asks to install if you are building more than one package,
| # so no need to run 'cpt i ...'
| cpt b libelf ncurses
`----
In the vanilla kernel sources, you need perl to compile the kernel,
but it can be easily patched out. You will need to apply the following
patch. Patch was written by [E5ten]. You will need to obtain and apply
the patch in the kernel source directory.
,----
| wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch
| patch -p1 < kernel-no-perl.patch
`----
[E5ten] <https://github.com/E5ten>
2.4.3 Building the kernel
-------------------------
Next step is configuring and building the kernel. You can check
Gentoo's [kernel configuration guide] to learn more about the
matter. Overall, Gentoo Wiki is a good place to learn about
configuration according to your hardware. The following will assume a
monolithic kernel.
,----
| make menuconfig
| make
| install -Dm755 $(make -s image_name) /boot/vmlinuz-linux
`----
[kernel configuration guide]
<https://wiki.gentoo.org/wiki/Kernel/Configuration>
2.5 Making your system bootable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In order to be able to boot your fresh system, wou will need an
init-daemon, init-scripts and a bootloader. The init daemon is already
provided by busybox, but you can optionally change it.
2.5.1 Bootloader
----------------
In the main repository, there is efibootmgr and grub to serve as
bootloaders. efibootmgr can be used as a standalone bootloader, or
can be used to install grub in a UEFI environment. efibootmgr is
needed unless you are using a device without UEFI support (or you
really want to use BIOS for a reason).
* 2.5.1.1 GRUB BIOS installation
,----
| cpt b grub && cpt i grub
| grub-install --target=i386-pc /dev/sdX
| grub-mkconfig -o /boot/grub/grub.cfg
`----
* 2.5.1.2 GRUB UEFI installation
,----
| cpt b efibootmgr && cpt i efibootmgr
| cpt b grub && cpt i grub
|
| grub-install --target=x86_64-efi \
| --efi-directory=esp \
| --bootloader-id=CarbsLinux
|
| grub-mkconfig -o /boot/grub/grub.cfg
`----
2.5.2 Init scripts
------------------
Only thing left to do is installing the init-scripts, and now you are
almost ready to boot your system!
,----
| cpt b carbs-init && cpt i carbs-init
`----
2.5.3 Fstab
-----------
You can now manually edit your fstab entry, or you can use the
genfstab tool. If you want to use the tool, exit the chroot and run
the following:
,----
| wget https://github.com/cemkeylan/genfstab/raw/master/genfstab
| chmod +x genfstab
| ./genfstab -U /mnt >> /mnt/etc/fstab
`----
2.6 Post-installation
~~~~~~~~~~~~~~~~~~~~~
The base installation is now complete, you can now fine tune your
system according to your needs. Rest of these instructions are
completely optional. You can check the rest of the documentation to
learn more about the system.
2.6.1 IRC
---------
The IRC channel for Carbs Linux is located in `#carbslinux' on
[libera.chat]. You can install the `catgirl' package from the
repository, or use a client of your preference to join. Feel free to
ask for help, or have a general chat.
[libera.chat] <https://libera.chat>
2.6.2 KISS repositories
-----------------------
There have been recent changes to the `kiss' package manager that
breaks compatibility with `cpt'. These changes throw away the entire
premise of their "static" packaging system. `cpt' will never implement
those changes, so don't expect any KISS package that was changed
during or after July 2021 to work with `cpt'.
3 Software
==========
The distribution aims to package essential and useful software needed
in a practical system. If the repository lacks a package that you use,
you may also easily package it yourself or request it to be added to
the default repositories over on the IRC channel (`#carbslinux' on
[Libera]).
This section goes over the details of some packaged software
[Libera] <https://libera.chat>
3.1 Init System
~~~~~~~~~~~~~~~
Carbs Linux init scripts are run by the init daemon (`busybox' by
default) on boot and shutdown processes. It also provides its own
halting program named shalt. This provides a portable method that
doesn't rely on non-POSIX external programs.
3.1.1 Configuring Init
----------------------
There are three ways you can change the behaviour of the init
system. Those are:
- Kernel Command Line
- `/etc/init/rc.conf' file
- Init Hooks
* 3.1.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, but all of them will be set as variables on the
init script. For example an example command line, and how it is
interpreted.
,----
| BOOT_IMAGE=/boot/vmlinuz root=/dev/sda2 rw loglevel=3 quiet
`----
This command line will be parsed to set the following variables:
,----
| BOOT_IMAGE=/boot/vmlinuz
| root=/dev/sda2
| rw=1
| loglevel=3
| quiet=1
`----
Some of these variables, such as `rw=/=ro', `loglevel', and `quiet',
will be used by the init system to change the behaviour of the
startup.
* 3.1.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.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, and lot more. Those hooks are added to the
`/etc/init' directory with the hook name as the suffix. For example, a
boot script will be placed as `/etc/init/my-hook.boot'. Currently,
there are 4 hooks that the user can use.
early-boot
Run after pseudo-filesystems are mounted.
boot
Run before the boot stage is completed.
pre.shutdown
Run first when shutting down.
umount
Run just before filesystems are unmounted.
post.shutdown
Run just before the system is halted.
3.1.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:
- `sinit'
- `busybox' init
- `runit'
- `shinit'
This example is for runit, but it will work with all init systems
packaged in the distribution repositories. See the
`cpt-alternatives(1)' manual page for more details.
,----
| cpt a runit /usr/bin/init
| cpt a runit /usr/bin/poweroff
| cpt a runit /usr/bin/reboot
`----
* 3.1.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 utilities for the new utilities to work. These commands
are for the init system currently running on your system and not the
one you are switching to.
Program Command
--------------------------------
busybox `busybox reboot'
runit `runit-init 6'
shinit/sinit `kill -s INT 1'
3.2 Wayland
~~~~~~~~~~~
Carbs Linux only supports Wayland displays as of January 2023. If your
system makes use of the X.org display system, read the section
[Switching from Xorg].
Wayland is a modern display server protocol intended as a replacement
for Xorg. Wayland has a much simpler architecture compared to X by
its careful design and implementation. Users who want to use a Wayland
compositor should follow this section.
[Switching from Xorg] See section 3.2.2
3.2.1 Enabling the Wayland repository
-------------------------------------
The `wayland' repository requires packages from `xorg' and `extra'
repositories. So you should set your `$CPT_PATH' so that `core' and
`extra' repositories precede the `wayland' repository, and the `xorg'
repository should come after `wayland'. Here is an example below,
where `$REPOSITORY' points to the root of your repository.
,----
| CPT_PATH=$REPOSITORY/core
| CPT_PATH=$CPT_PATH:$REPOSITORY/extra
| CPT_PATH=$CPT_PATH:$REPOSITORY/wayland
| export CPT_PATH
`----
After you have enabled your repositories, go ahead and install
`wayland' and `wayland-protocols' packages.
,----
| cpt-build wayland wayland-protocols
`----
3.2.2 Switching from Xorg
-------------------------
If you are already an Xorg user, you will need to rebuild some
packages so that they support `wayland'. If you don't have an `xorg'
system, feel free to skip this step. The packages that need a rebuild
are:
- `gtk+3'
- `gtk4'
- `mesa'
- `webkit2gtk'
For xorg support inside wayland sessions, you need to install the
`xwayland' package.
3.2.3 Installing a Compositor
-----------------------------
The `wayland' repository currently only contains `sway' as a Wayland
compositor, but you can package something else for your own.
,----
| cpt bi sway
`----
4 Contribution Guidelines
=========================
Thanks for taking your time to contribute! To maintain stylistic
behaviour throughout the repositories, one must adhere to these
conventions. Exceptions and changes may occur with good reasoning.
4.1 Conventions
~~~~~~~~~~~~~~~
[0010]
Try to keep the file readable.
[0011]
Characters on a line shouldn't exceed 100 characters.
[0012]
Make sure you don't have code commented out during
commit. Uncomment them or remove them completely.
[0013]
Do not add comments following the code, add them to the
top of the code. It makes it harder to read, and lines
longer. Here is an example:
,----
| # Good way of commenting.
| your code goes here
|
| your code goes here # Avoid this way of commenting.
`----
4.1.1 Shell Conventions
-----------------------
Shell is central to Carbs Linux projects. Most of the tools and
packages are written in POSIX sh.
[1010]
Use 4 spaces for indentation, don't use tabs.
[1020]
Make sure you don't use bash-specific code.
[1030]
Make sure you lint your code with `shellcheck' and if you are
new to POSIX sh, use `checkbashisms'.
[1040]
Don't spawn new processes if you don't absolutely need to,
especially during string manipulation.
[1041]
Never use a program for text manupilation that isn't
defined in the POSIX standard. This includes `gawk' and
`perl'.
[1042]
Instead of `$(basename $file)', use `${file##*}'.
[1043]
Instead of `$(dirname $file)', use `${file%/*}'.
,----
| # 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
`----
[1050]
Instead of backticks, use `$(..)'.
4.1.2 Repository Conventions
----------------------------
Repository conventions are important in order to ensure every package
resemble themselves. Here are the things to keep in mind:
[2010]
Prefer tarballs over git packages unless there is a sensible
reason. Here are some:
- Every patch is a new release. (See [vim])
- There are no releases. (See [sbase])
- Following a development branch.
- There has been a long time since the latest release, but
upstream is far ahead.
[2020]
Prefer sources without a dependency to `automake'. There are
usually distribution tarballs that are `autoconf''ed. Don't
submit tarballs with an automake dependency unless you are
*sure* there is no alternative.
[2030]
Avoid these packages:
dbus
Usually can be disabled by `--disable-dbus'.
gettext
Usually can be disabled by `--disable-nls'.
[2040]
- Always install a package to the `/usr' prefix.
- All binaries should go to `/usr/bin', not `/usr/sbin' or any
other directory.
- All libraries should go to `/usr/lib'.
[2050]
All build files on the repository should be a POSIX shell
script, and must start with `#!/bin/sh -e'.
The next section is about package templates that should be used in
order to ensure stylistic consistency. Note that the option
configurations shouldn't be taken literally, they are meant as
examples.
[vim] <https://github.com/vim/vim>
[sbase] <https://git.suckless.org/sbase>
* 4.1.2.1 Make [2210]
,----
| #!/bin/sh -e
|
| make
| make DESTDIR="$1" PREFIX=/usr install
`----
* 4.1.2.2 Configure/Make [2211]
,----
| #!/bin/sh -e
|
| ./configure \
| --prefix=/usr \
| --disable-option \
| --enable-option
|
| make
| make DESTDIR="$1" install
`----
* 4.1.2.3 Autoconf/Automake [2212]
,----
| #!/bin/sh -e
|
| autoreconf -fi
|
| ./configure \
| --prefix=/usr \
| --disable-option \
| --enable-option
|
| make
| make DESTDIR="$1" install
`----
* 4.1.2.4 Meson [2220]
The distribution provides a `cl-meson' wrapper script which sets some
common options like installation directories, disables downloading
subprojects among other things. This is the preferred method for
packages.
,----
| #!/bin/sh -e
|
| export DESTDIR=$1
|
| cl-meson \
| -Doption=false \
| -Doption2=true \
| . output
|
| ninja -C output
| ninja -C output install
`----
* 4.1.2.5 Cmake [2230]