Merge pull request #11 from zarhus/use-kas-machine-var

Use KAS_MACHINE var

Author: DaniilKl

docs/getting-started/building.md

@@ -52,26 +52,51 @@ This guide will demonstrate how to build a Zarhus OS image from zero!
 
 ## Build
 
-From `yocto` directory run:
+Depending on which features you want to have in your build, pass the desired
+`.yml` files via command line. You can read more on that in
+[kas documentation.](https://kas.readthedocs.io/en/latest/userguide/project-configuration.html#including-configuration-files-via-the-command-line)
+The files should be passed in a specific order. The file which is passed after
+some file will override settings set by the previously-passed file.
+
+Currently, the following files are present in `meta-zarhus/kas`:
+
+* `common.yml`: common configuration file, should be included in all builds;
+* `cache.yml`: file for cache mirrors configuration;
+* `debug.yml`: adds debug functionalities into the final image;
+* `rockchip.yml`: Rockchip-specific target configuration file, should be used
+  for Rockchip builds;
+* `webkit.yml`: includes Webkit and some additional functionalities into build.
+
+Then check BSP layers for available target platform (target platforms configs
+are located in `conf/machine` directory of every BSP layer) and choose one.
+Then, from `yocto` directory run:
 
 ```shell
-$ SHELL=/bin/bash kas-container build meta-zarhus/kas-IMAGE_TYPE.yml
+SHELL=/bin/bash KAS_MACHINE=<TARGET_NAME> kas-container build <KAS_FILES>
 ```
 
 !!! note
 
-    Replace `IMAGE_TYPE` with either `debug` or `prod`.
+    Replace `<TARGET_NAME>` with the name of the chosen target
+    configuration file, and `<KAS_FILES>` with a list of kas files, separated by
+    `:`.
 
-Image build takes time, so be patient and after the build finishes you should see
-something similar to this (the exact tasks numbers may differ):
+For example:
 
 ```shell
-Initialising tasks: 100% |###########################################################################################| Time: 0:00:01
-Sstate summary: Wanted 2 Found 0 Missed 2 Current 931 (0% match, 99% complete)
-NOTE: Executing Tasks
-NOTE: Tasks Summary: Attempted 2532 tasks of which 2524 didn't need to be rerun and all succeeded.
+SHELL=/bin/bash KAS_MACHINE=orangepi-cm4 kas-container build meta-zarhus/kas/common.yml:meta-zarhus/kas/rockchip.yml
 ```
 
+* Image build takes time, so be patient and after build's finish you should see
+something similar to (the exact tasks numbers may differ):
+
+  ```shell
+  Initialising tasks: 100% |###########################################################################################| Time: 0:00:01
+  Sstate summary: Wanted 2 Found 0 Missed 2 Current 931 (0% match, 99% complete)
+  NOTE: Executing Tasks
+  NOTE: Tasks Summary: Attempted 2532 tasks of which 2524 didn't need to be rerun and all succeeded.
+  ```
+
 # Verification
 
 The build should finish without errors or warnings.

docs/getting-started/flashing.md

@@ -66,7 +66,7 @@ You should see output similar to this:
 ```shell
 bmaptool: info: block map format version 2.0
 bmaptool: info: 85971 blocks of size 4096 (335.8 MiB), mapped 42910 blocks (167.6 MiB or 49.9%)
-bmaptool: info: copying image 'zarhus-base-image-debug-zarhus-machine-cm3.rootfs.wic.gz' to block device '/dev/sdx' using bmap file 'zarhus-base-image-debug-zarhus-machine-cm3.rootfs.wic.bmap'
+bmaptool: info: copying image 'zarhus-base-image-debug-radxa-cm3.rootfs.wic.gz' to block device '/dev/sdx' using bmap file 'zarhus-base-image-debug-radxa-cm3.rootfs.wic.bmap'
 bmaptool: info: 100% copied
 bmaptool: info: synchronizing '/dev/sdx'
 bmaptool: info: copying time: 11.1s, copying speed 15.1 MiB/sec

docs/getting-started/verification.md

@@ -85,9 +85,9 @@ Welcome to Distro for Zarhus product 0.1.0 (scarthgap)!
 [  OK  ] Finished Record Runlevel Change in UTMP.
 [  OK  ] Finished Virtual Console Setup.
 
-Distro for Zarhus product 0.1.0 zarhus-machine-cm3 ttyS2
+Distro for Zarhus product 0.1.0 radxa-cm3 ttyS2
 
-zarhus-machine-cm3 login:
+radxa-cm3 login:
 ```
 
 !!! note

docs/supported-targets/radxa-cm3.md

@@ -131,7 +131,7 @@ guide](../getting-started/building.md).
 After the image has been built - locate and copy the image to a known location:
 
 ```bash
-cp build/tmp/deploy/images/zarhus-machine-cm3/zarhus-base-image-IMAGE_VER-zarhus-machine-cm3.rootfs.wic.gz ./
+cp build/tmp/deploy/images/radxa-cm3/zarhus-base-image-IMAGE_VER-radxa-cm3.rootfs.wic.gz ./
 ```
 
 !!! note
@@ -142,7 +142,7 @@ cp build/tmp/deploy/images/zarhus-machine-cm3/zarhus-base-image-IMAGE_VER-zarhus
 Decompress the image (`rkdeveloptool` needs decompressed image):
 
 ```bash
-gunzip zarhus-base-image-IMAGE_VER-zarhus-machine-cm3.rootfs.wic.gz
+gunzip zarhus-base-image-IMAGE_VER-radxa-cm3.rootfs.wic.gz
 ```
 
 !!! note
@@ -153,8 +153,8 @@ gunzip zarhus-base-image-IMAGE_VER-zarhus-machine-cm3.rootfs.wic.gz
 Now you should have decompressed image file in your directory:
 
 ```bash
-file ./zarhus-base-image-IMAGE_VER-zarhus-machine-cm3.rootfs.wic
-zarhus-base-image-IMAGE_VER-zarhus-machine-cm3.rootfs.wic: DOS/MBR boot sector; partition 1 : ID=0xee, start-CHS (0x0,0,2), end-CHS (0x3ff,255,63), startsector 1, 687763 sectors, extended partition table (last)
+file ./zarhus-base-image-IMAGE_VER-radxa-cm3.rootfs.wic
+zarhus-base-image-IMAGE_VER-radxa-cm3.rootfs.wic: DOS/MBR boot sector; partition 1 : ID=0xee, start-CHS (0x0,0,2), end-CHS (0x3ff,255,63), startsector 1, 687763 sectors, extended partition table (last)
 ```
 
 !!! note
@@ -216,7 +216,7 @@ Downloading bootloader succeeded.
 Flash eMMC:
 
 ```bash
-rkdeveloptool wl 0x0 zarhus-base-image-IMAGE_VER-zarhus-machine-cm3.rootfs.wic
+rkdeveloptool wl 0x0 zarhus-base-image-IMAGE_VER-radxa-cm3.rootfs.wic
 Write LBA from file (100%)
 ```
 

mkdocs.yml

@@ -24,12 +24,12 @@ extra:
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/zarhus
-    # - icon: fontawesome/brands/mastodon
-    #   link: https://fosstodon.org/@TBD
-    # - icon: fontawesome/brands/twitter
-    #   link: https://twitter.com/TBD
-    # - icon: fontawesome/brands/reddit
-    #   link: https://www.reddit.com/r/TBD
+      # - icon: fontawesome/brands/mastodon
+      #   link: https://fosstodon.org/@TBD
+      # - icon: fontawesome/brands/twitter
+      #   link: https://twitter.com/TBD
+      # - icon: fontawesome/brands/reddit
+      #   link: https://www.reddit.com/r/TBD
 extra_css:
   - stylesheets/extra.css
 markdown_extensions:
@@ -73,9 +73,9 @@ nav:
       - 'Radxa':
           - 'Radxa CM3': supported-targets/radxa-cm3.md
   - 'Guides':
-    - 'Managing packages': guides/managing-packages.md
-    - 'Managing layers': guides/managing-layers.md
-    - 'Secure Boot Verification': guides/secure-boot/secure-boot-verification.md
+      - 'Managing packages': guides/managing-packages.md
+      - 'Managing layers': guides/managing-layers.md
+      - 'Secure Boot Verification': guides/secure-boot/secure-boot-verification.md
   - 'Development Process':
       - 'Standard Release Process': development-process/standard-release-process.md
   - 'FAQ': faq.md