archive repository

Fix KVM instructions for zsh users

.github/workflows/publish.yml

@@ -28,8 +28,9 @@ jobs:
         wget https://github.com/clearlinux/clear-linux-documentation-zh-CN/releases/latest/download/clearlinux-docs-zh-CN.tar.gz
         mkdir source/_build/html/zh_CN
         tar xvzf clearlinux-docs-zh-CN.tar.gz -C source/_build/html/zh_CN
+        touch source/_build/html/.nojekyll
         mv source/_build/html $HOME/output
-    - name: Deploy the docs
+    - name: Deploy and publish docs
       run: |
         cd $HOME/output
         git init
@@ -38,7 +39,3 @@ jobs:
         git add .
         git commit -m "latest html output"
         git push -f https://${GITHUB_ACTOR}:${{secrets.ACCESS_TOKEN}}@github.com/clearlinux/clear-linux-documentation.git HEAD:latestHTML
-    - name: Publish the docs
-      run: |
-        wget ${{secrets.PUBLISH_URL}}
-        cat clearlinux-latest

Makefile

@@ -5,38 +5,38 @@ SHELL := /bin/bash
 PY_VERSION ?= 3.6
 
 all:
-	make -C source html
+	$(MAKE) -C source html
 
 htmlall:
-	make -C source htmlall
+	$(MAKE) -C source htmlall
 
 htmlzh:
-	make -C source htmlzh
+	$(MAKE) -C source htmlzh
 
 htmlde:
-	make -C source htmlde
+	$(MAKE) -C source htmlde
 
 html:
-	make -C source html
+	$(MAKE) -C source html
 
 linkcheck:
-	make -C source linkcheck
+	$(MAKE) -C source linkcheck
 
 py:
-	make -C source py
+	$(MAKE) -C source py
 
 man:
-	make -C source man
+	$(MAKE) -C source man
 
 clean-man:
-	make -C source clean-man
+	$(MAKE) -C source clean-man
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html       to make standalone HTML files"
 
 clean:
-	make -C source clean
+	$(MAKE) -C source clean
 	rm -rf venv
 
 venv:

README.md

@@ -0,0 +1,7 @@
+## DISCONTINUATION OF PROJECT. 
+
+This project will no longer be maintained by Intel. 
+
+Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.
+
+Contact: webadmin@linux.intel.com  

requirements.txt

@@ -1,10 +1,10 @@
-breathe==4.9.1
-sphinx==2.2.0
-docutils==0.14
+breathe
+sphinx
+docutils
 sphinx_rtd_theme
-sphinx-intl==2.0.0
-sphinx-sitemap==1.0.2
-Jinja2==2.11.3
-GitPython==3.0.8
-sphinx-tabs
+sphinx-intl
+sphinx-sitemap
+Jinja2
+GitPython
+sphinx-tabs>1
 sphinx-copybutton

source/collaboration/collaboration.rst

@@ -9,7 +9,7 @@ There are multiple ways to help improve our documentation:
   repository.
 * `Log an issue`_: Enter an issue in the documentation repository for
   minor issues such as typos.
-* `Make a suggestion`_: Send your documentation suggestion to the mailing list.
+* `Make a suggestion`_: Send your documentation suggestion to the dev email inbox.
 * Test documentation: Step through our guides and tutorials to verify the
   instructions. `Log an issue`_ or `submit a pull request`_ with your findings.
 
@@ -64,11 +64,11 @@ We use the following references for grammar, style, and formatting:
 
 
 .. _`code of conduct`: https://clearlinux.org/community/code-of-conduct
-.. _Make a suggestion: https://lists.clearlinux.org/postorius/lists/dev.lists.clearlinux.org/
+.. _Make a suggestion: mailto:dev@clearlinux.discoursemail.com
 .. _GitHub flow: https://guides.github.com/introduction/flow/
 .. _Log an issue: https://github.com/clearlinux/clear-linux-documentation/issues
 .. _Contribute via GitHub: https://github.com/clearlinux/clear-linux-documentation
 .. _submit a pull request: https://github.com/clearlinux/clear-linux-documentation
 .. _documentation repository: https://github.com/clearlinux/clear-linux-documentation
 .. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/
-.. _Merriam-Webster Dictionary: https://www.merriam-webster.com/
+.. _Merriam-Webster Dictionary: https://www.merriam-webster.com/

source/conf.py

@@ -86,7 +86,7 @@ author = u'many'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -133,23 +133,14 @@ rst_epilog = """
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#html_theme = 'sphinx_rtd_theme'
-html_theme = 'otc_tcs_sphinx_theme'
+html_theme = 'bizstyle'
 
 version = current_version = "latest"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-  'canonical_url': 'docs.01.org/clearlinux/',
-  'style_nav_header_background': '#007ab2',
-  'navigation_depth': 4,
-  'display_version': False,
-  'collapse_navigation': False,
-  'prev_next_buttons_location': 'None',
-  'sticky_navigation': True
-}
+html_theme_options = {}
 
 html_context = {
     "display_github": True, # Integrate GitHub
@@ -158,12 +149,12 @@ html_context = {
     "github_version": "master", # Version
     "conf_py_path": "/source/", # Path in the checkout to the docs root
     "current_version": current_version,
-    "languages": ( ("English", "/clearlinux/latest"),
-                   ("简体中文 (Simplified Chinese)", "/clearlinux/latest/zh_CN")
+    "languages": ( ("English", "/clear-linux-documentation"),
+                   ("简体中文 (Simplified Chinese)", "/clear-linux-documentation/zh_CN")
                    #("Chinese", "/clearlinux/latest/zh_CN")
                  ),
-    "versions": ( ("latest", "/clearlinux/latest"),
-                  ("Future versions", "/clearlinux/latest"))
+    "versions": ( ("latest", "/clear-linux-documentation"),
+                  ("future versions","/clear-linux-documentation"))
                   #("L19.01", "/clearlinux/L19.01"))
 }
 
@@ -347,5 +338,5 @@ texinfo_documents = [
 locale_dirs = ['../locale/'] # path for lang-specific po files.
 gettext_compact = False # optional.
 
-html_baseurl = 'https://docs.01.org/clearlinux/'
+html_baseurl = 'https://clearlinux.github.io/clear-linux-documentation'
 

source/get-started/virtual-machine-install/kvm.rst

@@ -41,7 +41,7 @@ Download and launch the virtual machine image
 
    .. code-block:: bash
 
-      curl -o clear.img.xz https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images.json | grep -o clear-'[0-9]'*-kvm.img.xz | head -1)
+      curl -o clear.img.xz https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images.json | grep -o 'clear-[0-9]*-kvm.img.xz' | head -1)
 
 #. Uncompress the downloaded image:
 

source/guides/kernel/change-kernel-boot.rst

@@ -0,0 +1,234 @@
+.. _change-kernel-boot:
+
+Change Kernel Boot
+########################
+
+This tutorial explains the process of change kernel boot entry |CL-ATTR|.
+
+.. contents::
+   :local:
+   :depth: 1
+
+Description
+***********
+
+For this tutorial, you will modify your kernel list to boot with the kernel you want to use. This process is valid when you cannot compile third-party kernel modules and need to come back to old, or if you compile your custom kernel.
+
+
+Get the current boot status
+***************************
+
+.. code-block:: bash
+
+   bootctl status
+
+This is an example output:
+
+.. code-block:: bash
+
+    System:
+        Firmware: UEFI 2.70 (HP 265.256)
+        Firmware Arch: x64
+        Secure Boot: disabled
+        TPM2 Support: yes
+        Measured UKI: no
+        Boot into FW: supported
+  
+    Current Boot Loader:
+          Product: systemd-boot 255
+         Features: ✓ Boot counting
+                   ✓ Menu timeout control
+                   ✓ One-shot menu timeout control
+                   ✓ Default entry control
+                   ✓ One-shot entry control
+                   ✓ Support for XBOOTLDR partition
+                   ✓ Support for passing random seed to OS
+                   ✓ Load drop-in drivers
+                   ✓ Support Type #1 sort-key field
+                   ✓ Support @saved pseudo-entry
+                   ✓ Support Type #1 devicetree field
+                   ✓ Enroll SecureBoot keys
+                   ✓ Retain SHIM protocols
+                   ✓ Menu can be disabled
+                   ✓ Boot loader sets ESP information
+              ESP: /dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5
+             File: └─/EFI/org.clearlinux/loaderx64.efi
+    
+    Random Seed:
+     System Token: set
+           Exists: yes
+    
+    Available Boot Loaders on ESP:
+              ESP: /boot (/dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5)
+             File: ├─/EFI/systemd/systemd-bootx64.efi (systemd-boot 255)
+                   └─/EFI/BOOT/BOOTX64.EFI (systemd-boot 255)
+    
+    Boot Loaders Listed in EFI Variables:
+            Title: Linux bootloader
+               ID: 0x0007
+           Status: active, boot-order
+        Partition: /dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5
+             File: └─/EFI/org.clearlinux/bootloaderx64.efi
+    
+            Title: Linux Boot Manager
+               ID: 0x0001
+           Status: active, boot-order
+        Partition: /dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5
+             File: └─/EFI/systemd/systemd-bootx64.efi
+    
+            Title: Windows Boot Manager
+               ID: 0x0000
+           Status: active, boot-order
+        Partition: /dev/disk/by-partuuid/48d8a9eb-d84d-4a62-8302-edff383290e5
+             File: └─/EFI/Microsoft/Boot/bootmgfw.efi
+    
+    Boot Loader Entries:
+            $BOOT: /boot (/dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5)
+            token: clear-linux-os
+    
+    Default Boot Loader Entry:
+             type: Boot Loader Specification Type #1 (.conf)
+            title: Clear Linux OS (Clear-linux-native-6.8.10-1434.conf)
+               id: Clear-linux-native-6.8.10-1434.conf
+           source: /boot//loader/entries/Clear-linux-native-6.8.10-1434.conf
+            linux: /boot//EFI/org.clearlinux/kernel-org.clearlinux.native.6.8.10-1434
+           initrd: /boot//EFI/org.clearlinux/freestanding-00-early-ucode.cpio
+                   /boot//EFI/org.clearlinux/initrd-org.clearlinux.native.6.8.10-1434
+                   /boot//EFI/org.clearlinux/freestanding-clr-init.cpio.gz
+                   /boot//EFI/org.clearlinux/freestanding-i915-firmware.cpio
+          options: root=UUID=67e7ac9a-f7a1-4d5e-bbd6-012f5fa81cb5 rd.luks.uuid=abe6aaf2-3425-4eb1-b7f5-3f36746426fa quiet console=tty0 console=ttyS0,115200n8 cryptomgr.notests init=/usr/bin/initra-desktop initcall>
+    lines 20-71/71 (END)
+                   ✓ Support @saved pseudo-entry
+                   ✓ Support Type #1 devicetree field
+                   ✓ Enroll SecureBoot keys
+                   ✓ Retain SHIM protocols
+                   ✓ Menu can be disabled
+                   ✓ Boot loader sets ESP information
+              ESP: /dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5
+             File: └─/EFI/org.clearlinux/loaderx64.efi
+    
+    Random Seed:
+     System Token: set
+           Exists: yes
+    
+    Available Boot Loaders on ESP:
+              ESP: /boot (/dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5)
+             File: ├─/EFI/systemd/systemd-bootx64.efi (systemd-boot 255)
+                   └─/EFI/BOOT/BOOTX64.EFI (systemd-boot 255)
+    
+    Boot Loaders Listed in EFI Variables:
+            Title: Linux bootloader
+               ID: 0x0007
+           Status: active, boot-order
+        Partition: /dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5
+             File: └─/EFI/org.clearlinux/bootloaderx64.efi
+    
+            Title: Linux Boot Manager
+               ID: 0x0001
+           Status: active, boot-order
+        Partition: /dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5
+             File: └─/EFI/systemd/systemd-bootx64.efi
+    
+            Title: Windows Boot Manager
+               ID: 0x0000
+           Status: active, boot-order
+        Partition: /dev/disk/by-partuuid/48d8a9eb-d84d-4a62-8302-edff383290e5
+             File: └─/EFI/Microsoft/Boot/bootmgfw.efi
+    
+    Boot Loader Entries:
+            $BOOT: /boot (/dev/disk/by-partuuid/ea2e4278-5c0c-4498-bc99-dfc48a71ceb5)
+            token: clear-linux-os
+    
+    Default Boot Loader Entry:
+             type: Boot Loader Specification Type #1 (.conf)
+            title: Clear Linux OS (Clear-linux-native-6.8.10-1434.conf)
+               id: Clear-linux-native-6.8.10-1434.conf
+           source: /boot//loader/entries/Clear-linux-native-6.8.10-1434.conf
+            linux: /boot//EFI/org.clearlinux/kernel-org.clearlinux.native.6.8.10-1434
+           initrd: /boot//EFI/org.clearlinux/freestanding-00-early-ucode.cpio
+                   /boot//EFI/org.clearlinux/initrd-org.clearlinux.native.6.8.10-1434
+                   /boot//EFI/org.clearlinux/freestanding-clr-init.cpio.gz
+                   /boot//EFI/org.clearlinux/freestanding-i915-firmware.cpio
+          options: root=UUID=67e7ac9a-f7a1-4d5e-bbd6-012f5fa81cb5 rd.luks.uuid=abe6aaf2-3425-4eb1-b7f5-3f36746426fa quiet console=tty0 console=ttyS0,115200n8 cryptomgr.notests init=/usr/bin/initra-desktop initcall_debug intel_iommu=igfx_off kvm-intel.nested=1 no_timer_check noreplace-smp page_alloc.shuffle=1 rcupdate.rcu_expedited=1 rootfstype=ext4,btrfs,xfs,f2fs tsc=reliable rw module.sig_unenforce rootflags=x-systemd.device-timeout=0
+
+Get the kernel list installed
+*****************************
+
+.. code-block:: bash
+
+   bootctl list
+
+And example output:
+
+.. code-block:: bash
+
+    type: Boot Loader Specification Type #1 (.conf)
+    title: Clear Linux OS (Clear-linux-preempt_rt-6.1.38-105.conf)
+    id: Clear-linux-preempt_rt-6.1.38-105.conf
+    source: /boot//loader/entries/Clear-linux-preempt_rt-6.1.38-105.conf
+    linux: /boot//EFI/org.clearlinux/kernel-org.clearlinux.preempt_rt.6.1.38-105
+    initrd: /boot//EFI/org.clearlinux/freestanding-00-early-ucode.cpio
+            /boot//EFI/org.clearlinux/freestanding-clr-init.cpio.gz
+            /boot//EFI/org.clearlinux/freestanding-i915-firmware.cpio
+    options: root=UUID=67e7ac9a-f7a1-4d5e-bbd6-012f5fa81cb5 rd.luks.uuid=abe6aaf2-3425-4eb1-b7f5-3f36746426fa quiet console=tty0 console=ttyS0,115200n8 cryptomgr.notests init=/usr/bin/initra-desktop initcall_debug intel_iommu=igfx_off kvm-intel.nested=1 no_timer_check noreplace-smp page_alloc.shuffle=1 rcupdate.rcu_expedited=1 rootfstype=ext4,btrfs,xfs t>
+
+    type: Boot Loader Specification Type #1 (.conf)
+    title: Clear Linux OS (Clear-linux-native-6.9.1-1436.conf)
+    id: Clear-linux-native-6.9.1-1436.conf
+    source: /boot//loader/entries/Clear-linux-native-6.9.1-1436.conf
+    linux: /boot//EFI/org.clearlinux/kernel-org.clearlinux.native.6.9.1-1436
+    initrd: /boot//EFI/org.clearlinux/freestanding-00-early-ucode.cpio
+            /boot//EFI/org.clearlinux/initrd-org.clearlinux.native.6.9.1-1436
+            /boot//EFI/org.clearlinux/freestanding-clr-init.cpio.gz
+            /boot//EFI/org.clearlinux/freestanding-i915-firmware.cpio
+    options: root=UUID=67e7ac9a-f7a1-4d5e-bbd6-012f5fa81cb5 rd.luks.uuid=abe6aaf2-3425-4eb1-b7f5-3f36746426fa quiet console=tty0 console=ttyS0,115200n8 cryptomgr.notests init=/usr/bin/initra-desktop initcall_debug intel_iommu=igfx_off kvm-intel.nested=1 no_timer_check noreplace-smp page_alloc.shuffle=1 rcupdate.rcu_expedited=1 rootfstype=ext4,btrfs,xfs,f>
+
+    type: Boot Loader Specification Type #1 (.conf)
+    title: Clear Linux OS (Clear-linux-native-6.8.10-1434.conf) (default) (selected)
+    id: Clear-linux-native-6.8.10-1434.conf
+    source: /boot//loader/entries/Clear-linux-native-6.8.10-1434.conf
+    linux: /boot//EFI/org.clearlinux/kernel-org.clearlinux.native.6.8.10-1434
+    initrd: /boot//EFI/org.clearlinux/freestanding-00-early-ucode.cpio
+            /boot//EFI/org.clearlinux/initrd-org.clearlinux.native.6.8.10-1434
+            /boot//EFI/org.clearlinux/freestanding-clr-init.cpio.gz
+            /boot//EFI/org.clearlinux/freestanding-i915-firmware.cpio
+    options: root=UUID=67e7ac9a-f7a1-4d5e-bbd6-012f5fa81cb5 rd.luks.uuid=abe6aaf2-3425-4eb1-b7f5-3f36746426fa quiet console=tty0 console=ttyS0,115200n8 cryptomgr.notests init=/usr/bin/initra-desktop initcall_debug intel_iommu=igfx_off kvm-intel.nested=1 no_timer_check noreplace-smp page_alloc.shuffle=1 rcupdate.rcu_expedited=1 rootfstype=ext4,btrfs,xfs,f>
+
+    type: Automatic
+    title: Reboot Into Firmware Interface
+    id: auto-reboot-to-firmware-setup
+    source: /sys/firmware/efi/efivars/LoaderEntries-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f
+
+Set default kernel to boot
+**************************
+
+You can check the id from the latest command:
+
+.. code-block:: bash
+
+   bootctl list |grep id: |cut -f 2 -d ":"
+     id: Clear-linux-preempt_rt-6.1.38-105.conf
+     id: Clear-linux-native-6.9.1-1436.conf
+     id: Clear-linux-native-6.8.10-1434.conf
+     id: auto-reboot-to-firmware-setup
+
+
+Set the kernel
+
+.. code-block:: bash
+
+   sudo bootctl set-default ID
+
+For example to set 6.9.1 entry:
+
+.. code-block:: bash
+
+   sudo bootctl set-default Clear-linux-native-6.9.1-1436.conf
+
+Just reboot
+
+.. code-block:: bash
+
+   sudo systemctl reboot
+
+You will boot with the kernel set before.

source/index.rst

@@ -50,7 +50,6 @@
 
       **Community**
 
-      | `Ask the Clear Linux experts <https://clearlinux.org/community/mailing-list>`_
       | `Clear Linux Forum <https://community.clearlinux.org/>`_
       | `irc.libera.chat IRC: #clearlinux <https://kiwiirc.com/client/irc.libera.chat/?nick=web_guest|?#clearlinux>`_