[update] : Added comments

diff --git a/default.conf b/default.conf
index d5599ef..27067f8 100644 (file)
--- a/default.conf
+++ b/default.conf
@@ -13,8 +13,10 @@
 #
 # Some values described here will be overridden by the arguments.
 # If you want to prohibit overwriting with arguments, use the config of each channel.
+# Create the configuration file (config) for each channel based on this file.
 #
 # This configuration file follows the bash syntax.
+# Do not write any code other than the variable definitions specified in this script.
 #
 
 
@@ -24,24 +26,31 @@
 arch=$(uname -m)
 
 # OS name used for startup screen, etc.
+# This setting cannot be changed by an argument.
 os_name="Alter Linux"
 
 # OS name used for the name of the image file.
+# This setting cannot be changed by an argument.
 iso_name=alterlinux
 
 # Image file label
+# This setting cannot be changed by an argument.
 iso_label="ALTER_$(date +%Y%m%d)"
 
 # Image file creator information
 iso_publisher='Fascode Network <https://fascode.net>'
 
-# Image file name (not file name)
+# Image name (not file name)
+# This setting cannot be changed by an argument.
 iso_application="${os_name} Live/Rescue CD"
 
 # Image file version
+# If gitversion (--gitversion) is enabled, Git's revision will be added to the end of this value.
+# This setting cannot be changed by an argument.
 iso_version=$(date +%Y.%m.%d)
 
 # Directory name used for installation
+# This setting cannot be changed by an argument.
 install_dir=alter
 
 # Work directory to execute pacstrap etc
@@ -54,6 +63,7 @@ out_dir=out
 
 # Key used for signature
 # Change the default behavior of "-g" and "--gpgkey".
+# This setting cannot be changed by an argument.
 gpg_key=
 
 
@@ -69,6 +79,7 @@ theme_name="alter-logo"
 # Set the package name of the plymouth theme.
 # Install only if plymouth is enabled.
 # If it is not packaged, leave this item empty and place those files in airootfs.
+# This setting cannot be changed by an argument.
 theme_pkg="plymouth-theme-alter-logo-git"
 
 
@@ -101,8 +112,9 @@ sfs_comp_opt=""
 # Channel developers should use this.
 defaultusername='alter'
 
-# Set the live environment user name (force)
+# Set the live environment user name
 # Change the default behavior of "-u" and "--user".
+# Overrides default settings
 username="alter"
 
 # Set the live environment user password
@@ -136,6 +148,7 @@ nocolor=false
 
 # If set to true, do not check dependent packages.
 # Change the default behavior of "--nodepend".
+# Dependent packages are defined in the following array.
 nodepend=false
 
 # Do not check the current kernel or load kernel modules.
@@ -161,12 +174,17 @@ msgdebug=false
 
 # If set to true, enable git version
 # Change the default behavior of "--gitversion".
+# Git version is generated with the following code
+# $ git rev-parse --short HEAD
 gitversion=false
 
 
 # List of packages required for build
 # The following packages are checked to see if they are installed before running build.sh
 # Also, wizard.sh will install it automatically.
+#
+# If you don't use AlterLinux repository, redefine this array in channel config
+# and remove alterlinux related packages from dependence.
 dependence=(
     "alterlinux-keyring"
 #   "archiso"