Skip to content

Commit aeba6fd

Browse files
lvicounlvicoun
committed
Added the kernel modules and drivers concepts.
1 parent 74543d8 commit aeba6fd

File tree

3 files changed

+107
-15
lines changed

3 files changed

+107
-15
lines changed

‎concepts/customizing-products-drivers.xml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
3+
<!-- This file can be edited downstream. -->
4+
<!DOCTYPE topic
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
10+
<!-- point back to this document with a similar comment added to your legacy doc piece -->
11+
<!-- refer to README.md for file and id naming conventions -->
12+
<!-- metadata is dealt with on the assembly level -->
13+
<topic xml:id="customizing-images-drivers"
14+
role="concept" xml:lang="en"
15+
xmlns="http://docbook.org/ns/docbook" version="5.2"
16+
xmlns:its="http://www.w3.org/2005/11/its"
17+
xmlns:xi="http://www.w3.org/2001/XInclude"
18+
xmlns:xlink="http://www.w3.org/1999/xlink"
19+
xmlns:trans="http://docbook.org/ns/transclusion">
20+
<info>
21+
<title>Concept</title><!-- can be changed via merge in the assembly -->
22+
<!--add author's email address-->
23+
<meta name="maintainer" content="" its:translate="no"/>
24+
<abstract><!-- can be changed via merge in the assembly -->
25+
<para>
26+
Introductory text
27+
</para>
28+
</abstract>
29+
</info>
30+
<section xml:id="concept-example-what-is">
31+
<title>What is foo bar?</title>
32+
<para>
33+
A paragraph of text, answering the question above and explaining the
34+
aim/function of foo bar.
35+
</para>
36+
</section>
37+
<section xml:id="concept-example-how-it-works">
38+
<title>How does foo bar work?</title>
39+
<para>
40+
A paragraph of text, answering the question above and explaining the
41+
mechanism behind foo bar.
42+
</para>
43+
<figure xml:id="fig-one">
44+
<title>A figure</title>
45+
<mediaobject>
46+
<imageobject role="html">
47+
<imagedata fileref="example.png"/>
48+
</imageobject>
49+
<imageobject role="fo">
50+
<imagedata fileref="example.png" width="85%"/>
51+
</imageobject>
52+
</mediaobject>
53+
</figure>
54+
</section>
55+
<section xml:id="concept-example-benefits">
56+
<title>Benefits of foo bar</title>
57+
<para>
58+
A paragraph of text, pointing out the benefits of foo bar.
59+
</para>
60+
</section>
61+
</topic>

‎concepts/customizing-products-kernel.xml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
3+
<!-- This file can be edited downstream. -->
4+
<!DOCTYPE topic
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
10+
<!-- point back to this document with a similar comment added to your legacy doc piece -->
11+
<!-- refer to README.md for file and id naming conventions -->
12+
<!-- metadata is dealt with on the assembly level -->
13+
<topic xml:id="customizing-images-kernel-modules"
14+
role="concept" xml:lang="en"
15+
xmlns="http://docbook.org/ns/docbook" version="5.2"
16+
xmlns:its="http://www.w3.org/2005/11/its"
17+
xmlns:xi="http://www.w3.org/2001/XInclude"
18+
xmlns:xlink="http://www.w3.org/1999/xlink"
19+
xmlns:trans="http://docbook.org/ns/transclusion">
20+
<info>
21+
<title>Packaging custom kernel modules</title><!-- can be changed via merge in the assembly -->
22+
<!--add author's email address-->
23+
<meta name="maintainer" content="[email protected]" its:translate="no"/>
24+
<abstract><!-- can be changed via merge in the assembly -->
25+
<para>
26+
The topic serves as a link to a SBP.
27+
</para>
28+
</abstract>
29+
</info>
30+
<para>
31+
Working with external kernel modules on SUSE Linux Enterprise systems requires a specific approach to ensure they remain compatible with kernel updates. The official Kernel Module Packages (KMP) Manual provides detailed guidelines on this process. This comprehensive guide covers everything from the background on kernel ABI stability to the step-by-step process of building, packaging, signing, and deploying your own kernel modules correctly.
32+
</para>
33+
</topic>

‎tasks/customizing-products-images.xml‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,10 @@ in the assembly -->
2424
<meta name="maintainer" content="[email protected]" its:translate="no"/>
2525
<abstract><!-- can be changed via merge in the assembly -->
2626
<para>
27-
The topic ocvers the process of building images suited to customers solutions.
27+
This section provides a brief guide for creating custom images based on &productname;, allowing you to build a system tailored to your solution's needs. The entire process relies on the KIWI NG image builder and can be summarized into the following key stages:
2828
</para>
2929
</abstract>
30-
</info>
31-
<para>
32-
The process of deployment images customization can be summarized into the following parts:
33-
</para>
30+
</info>
3431
<itemizedlist>
3532
<listitem>
3633
<para>
@@ -53,6 +50,10 @@ in the assembly -->
5350
</para>
5451
</listitem>
5552
</itemizedlist>
53+
<para>
54+
For a complete description of how KIWI GN works, refer to the <link
55+
xlink:href="https://osinside.github.io/kiwi/overview.html">KIWI documentation</link>.
56+
</para>
5657
<section xml:id="customizing-images-and-product-images-directory-structure">
5758
<title>Creating the directory structure</title>
5859
<para>
@@ -161,7 +162,7 @@ Navigate to the <filename>root</filename> directory.
161162
</step>
162163
<step>
163164
<para>
164-
Put your custom configuration file in that directory.
165+
Place your custom configuration file in that directory.
165166
</para>
166167
</step>
167168
</procedure>
@@ -179,24 +180,21 @@ Navigate to the <filename>root</filename> directory.
179180
<para>
180181
After you have prepared all necessary files and the directory structure, you can use <command>kiwi-ng</command> to build
181182
the image. To build it directly with <command>kiwi-ng</command> you need to have version
182-
included in &slea; 16.0 or higher. Alternatively, you can use a container that you can download
183-
<link xlink:href="https://registry.suse.com/repositories/bci-kiwi10">here</link>.
183+
included in &slea; 16.0 or higher. Alternatively, you can use a container.
184184
</para>
185185
<para>
186186
Then to build the image, proceed as follows:
187187
</para>
188188
<procedure>
189-
<step performance="optional">
189+
<step>
190190
<para>
191-
Downolad the container image.
191+
Either download the container image from the <link xlink:href="https://registry.suse.com/repositories/bci-kiwi10">registry</link>.
192192
</para>
193-
</step>
194-
<step performance="optional">
195-
<para>
196-
Install KIWI NG:
193+
<para>
194+
Or you can use KIWI directly after installing it:
197195
</para>
198196
<screen>&prompt.sudo;zypper install python3-kiwi</screen>
199-
</step>
197+
</step>
200198
<step>
201199
<para>
202200
Navigate to the <filename>build</filename> directory in your working directory.

0 commit comments

Comments
 (0)