[PATCH website v1 0/5] doc: refresh Cobalt installation guide

[PATCH website v1 0/5] doc: refresh Cobalt installation guide

[guang_feng_wang]

From: guang feng wang <guang_feng_wang@163.com>

Hi,

This series updates a few stale I-pipe-era references in the Xenomai 3
installation guide, mainly around the Cobalt setup path.

The page already documents Dovetail as a Cobalt-specific requirement,
but a few examples still refer to legacy I-pipe references.

The changes are limited to the following patches:

guang feng wang (5):
  doc: replace legacy I-pipe usage with Dovetail
  doc: update stale Cobalt kernel preparation example
  doc: mark old PowerPC and ARM build examples as historical
  doc: generalize ARM64 Cobalt build notes
  doc: update Cobalt boot log

 content/installation/_index.md | 39 ++++++++++++++++++++--------------
 1 file changed, 23 insertions(+), 16 deletions(-)

-- 
2.34.1

[PATCH website v1 1/5] doc: replace legacy I-pipe usage with Dovetail

[guang_feng_wang]

From: guang feng wang <guang_feng_wang@163.com>

The installation guide still documents prepare-kernel.sh and several
Cobalt kernel preparation examples with the legacy --ipipe option.

Update those examples to use the Dovetail option instead.

Signed-off-by: guang feng wang <guang_feng_wang@163.com>
---
 content/installation/_index.md | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/content/installation/_index.md b/content/installation/_index.md
index 0febbf6..673b51b 100644
--- a/content/installation/_index.md
+++ b/content/installation/_index.md
@@ -40,7 +40,7 @@ script which sets up the target kernel properly. The syntax is as
 follows:
 
     $ scripts/prepare-kernel.sh [--linux=<linux-srctree>]
-    [--ipipe=<ipipe-patch>] [--arch=<target-arch>]
+    [--dovetail=<dovetail-patch>] [--arch=<target-arch>]
 
 `--linux`  
 specifies the path of the target kernel source tree. Such kernel tree
@@ -197,7 +197,7 @@ typically run:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=x86 \
-      --ipipe=ipipe-core-X.Y.Z-x86-NN.patch
+      --dovetail=dovetail-core-X.Y.Z-x86-NN.patch
     $ make [ARCH=i386] xconfig/gconfig/menuconfig
 
 configure the kernel (see also the recommended settings
@@ -213,7 +213,7 @@ would be as follows:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=i386 \
-      --ipipe=ipipe-core-X.Y.Z-x86-NN.patch
+      --dovetail=dovetail-core-X.Y.Z-x86-NN.patch
     $ make xconfig/gconfig/menuconfig
 
 configure the kernel (see also the recommended settings
@@ -227,7 +227,7 @@ Similarly, for a 64bit platform, you would use:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=x86_64 \
-      --ipipe=ipipe-core-X.Y.Z-x86-NN.patch
+      --dovetail=dovetail-core-X.Y.Z-x86-NN.patch
     $ make xconfig/gconfig/menuconfig
 
 configure the kernel (see also the recommended settings
@@ -250,7 +250,7 @@ cross-compiler:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=powerpc \
-      --ipipe=ipipe-core-3.10.32-powerpc-1.patch
+      --dovetail=dovetail-core-X.Y.Z-powerpc-NN.patch
     $ make ARCH=powerpc CROSS_COMPILE=ppc_6xx- xconfig/gconfig/menuconfig
 
 …select the kernel and Xenomai options, save the configuration
@@ -267,7 +267,7 @@ will look like:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=arm \
-      --ipipe=ipipe-core-X.Y.Z-x86-NN.patch
+      --dovetail=dovetail-core-X.Y.Z-arm-NN.patch
     $ mkdir -p $build_root/linux
     $ make ARCH=arm CROSS_COMPILE=arm-none-linux-gnueabi- O=$build_root/linux \
       csb637_defconfig
@@ -285,7 +285,7 @@ follows:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=arm64 \
-       --ipipe=ipipe-core-X.Y.Z-arm64-NN.patch
+       --dovetail=dovetail-core-X.Y.Z-arm64-NN.patch
     $ mkdir -p $build_root/linux
     $ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- O=$build_root/linux \
       defconfig
-- 
2.34.1

[PATCH website v1 2/5] doc: update stale Cobalt kernel preparation example

[guang_feng_wang]

From: guang feng wang <guang_feng_wang@163.com>

The Cobalt kernel preparation example still refers to a linux-3.10-ipipe
tree. This is stale for the current Dovetail-based Cobalt setup path.

Update the example to use a generic Dovetail-enabled Linux tree instead.

Signed-off-by: guang feng wang <guang_feng_wang@163.com>
---
 content/installation/_index.md | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/content/installation/_index.md b/content/installation/_index.md
index 673b51b..265cb5a 100644
--- a/content/installation/_index.md
+++ b/content/installation/_index.md
@@ -59,11 +59,12 @@ if so.
 tells the script about the target architecture. If unspecified, the
 build host architecture suggested as a reasonable default.
 
-For instance, the following command would prepare the Linux tree located
-at `/home/me/linux-3.10-ipipe` in order to patch the Xenomai support in:
+For instance, the following command would prepare a Dovetail-enabled
+Linux tree located at `/home/me/linux-dovetail` in order to patch
+the Xenomai support in:
 
     $ cd xenomai-3
-    $ scripts/prepare-kernel.sh --linux=/home/me/linux-3.10
+    $ scripts/prepare-kernel.sh --linux=/home/me/linux-dovetail
 
 Note: The script will infer the location of the Xenomai kernel code from
 its own location within the Xenomai source tree. For instance, if
-- 
2.34.1

[PATCH website v1 3/5] doc: mark old PowerPC and ARM build examples as historical

[guang_feng_wang]

From: guang feng wang <guang_feng_wang@163.com>

Some architecture-specific build examples still describe old boards,
toolchains and kernel versions.

Keep these examples as historical references, but make it clear that new
Cobalt setups should follow the current Dovetail-based installation flow.

Signed-off-by: guang feng wang <guang_feng_wang@163.com>
---
 content/installation/_index.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/content/installation/_index.md b/content/installation/_index.md
index 265cb5a..4eaafcb 100644
--- a/content/installation/_index.md
+++ b/content/installation/_index.md
@@ -737,6 +737,11 @@ The remaining examples illustrate how to cross-compile Xenomai for
 various architectures. Of course, you would have to install the proper
 cross-compilation toolchain for the target system first.
 
+Some of the architecture-specific examples below are kept as historical
+references for older boards, toolchains and kernel versions. For new
+Cobalt setups, use the current Dovetail-based installation flow and
+adjust the toolchain and configuration to the target platform.
+
 ### Building the PPC32 libraries
 
 A typical cross-compilation setup, in order to build the Cobalt
-- 
2.34.1

[PATCH website v1 4/5] doc: generalize ARM64 Cobalt build notes

[guang_feng_wang]

From: guang feng wang <guang_feng_wang@163.com>

The ARM64 Cobalt kernel build example still refers to a Raspberry Pi 3
and Cortex-A53 setup, and mentions a Linaro toolchain explicitly.

Generalize the wording to describe a typical AArch64 cross build while
keeping aarch64-linux-gnu- as the example toolchain prefix.

Signed-off-by: guang feng wang <guang_feng_wang@163.com>
---
 content/installation/_index.md | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/content/installation/_index.md b/content/installation/_index.md
index 4eaafcb..12cf726 100644
--- a/content/installation/_index.md
+++ b/content/installation/_index.md
@@ -280,9 +280,8 @@ location
 
 #### Building Cobalt/arm64 kernel {#x3-build-cobalt-arm64}
 
-Using Linaro toolchain with the prefix aarch64-linux-gnu- and compiling
-for the raspberry pi 3 board (cortex-a53), cross compiling is as
-follows:
+Using an AArch64 cross toolchain with the prefix `aarch64-linux-gnu-`,
+a typical ARM64 cross build is as follows:
 
     $ cd $linux_tree
     $ $xenomai_root/scripts/prepare-kernel.sh --arch=arm64 \
-- 
2.34.1

[PATCH website v1 5/5] doc: update Cobalt boot log

[guang_feng_wang]

From: guang feng wang <guang_feng_wang@163.com>

The Cobalt boot check still shows an I-pipe log message. This is stale
for the current Dovetail-based Cobalt setup.

Replace it with an updated Cobalt boot log example.

Signed-off-by: guang feng wang <guang_feng_wang@163.com>
---
 content/installation/_index.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/content/installation/_index.md b/content/installation/_index.md
index 12cf726..30f54ce 100644
--- a/content/installation/_index.md
+++ b/content/installation/_index.md
@@ -937,11 +937,13 @@ messages like these:
 
 ```
     $ dmesg | grep -i xenomai
-    I-pipe: head domain Xenomai registered.
-    [Xenomai] Cobalt vX.Y.Z enabled
+    [Xenomai] scheduling class idle registered.
+    [Xenomai] scheduling class rt registered.
+    IRQ pipeline: high-priority Xenomai stage added.
+    [Xenomai] Cobalt vX.Y.Z
 ```
 
-If the kernel fails booting, or the log messages indicates an error
+If the kernel fails booting, or the log messages indicate an error
 status instead, see the [Troubleshooting guide]({{% relref
 "troubleshooting/_index.md#x3-failed-boot-klog" %}}).
 
-- 
2.34.1