Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review of the Build Recipe section #194

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Review of the Build Recipe section #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions xml/art-obs-beginners-guide.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,38 +63,38 @@ https://www.suse.com/communities/blog/suse-studio-integration/
<listitem>
<formalpara>
<title>Metadata</title>
<para>The package name and the description are mandatory. Other data
such as the version, the license, the upstream URL
is optional.</para>
<para>This is the package name, description, version, license
information, upstream URL...</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>Requirements</title>
<title>How to build the upstream source</title>
<para>
Packages depend on other packages to function properly.
There are two types of requirements:
<emphasis>build requirements</emphasis> and
<emphasis>installation requirements</emphasis>.
You need to indicate how to produce the files that will be
part of the package: where to get the sources, the patches to
apply if any, and which command(s) to run, e.g.
<command>make</command>.
</para>
<para>
These commands often require other packages to be installed
beforehand; for example, to build a C++ program, you need a
C++ compiler. You need to indicate this list of packages: the
<emphasis>build requirements</emphasis>.
</para>
</formalpara>
Comment on lines +78 to 85
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the reason for your validation problem. The <formalpara> element allows only one <para> element, not two (as in your case).

It's quite easy to fix. Just move the end tag </formalpara> a bit higher:

Suggested change
</para>
<para>
These commands often require other packages to be installed
beforehand; for example, to build a C++ program, you need a
C++ compiler. You need to indicate this list of packages: the
<emphasis>build requirements</emphasis>.
</para>
</formalpara>
</para>
</formalpara>
<para>
These commands often require other packages to be installed
beforehand; for example, to build a C++ program, you need a
C++ compiler. You need to indicate this list of packages: the
<emphasis>build requirements</emphasis>.
</para>

<para>
Build requirements are dependencies which are needed during the
build process in &obsa;. For example, a C++ program needs
a C++ compiler.
</para>
<para>
Installation requirements are dependencies which are needed when installing
the final package.
</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, it was there already :/

</listitem>
<listitem>
<formalpara>
<title>A Package List</title>
<title>Package contents, installation requirements and install/uninstall actions</title>
<para>
You need to list the files and directories to include into the
package.
</para>
<para>
To successfully install and remove a package and all its contents,
the package manager needs to know which files and directories belong to
which package.
The installed package may require other packages to function
properly. They are called the <emphasis>installation
requirements</emphasis>.
</para>
</formalpara>
Comment on lines +92 to 99
Copy link
Contributor

@tomschr tomschr Sep 3, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. You need to move your end tag </formalpara> from line 99 after the </para> from line 93.
(GitHub doesn't allow me to add suggestions over deleted lines.)

</listitem>
Expand Down