From f520c2f518cd9b7f8ea938f7327b35ee314a5501 Mon Sep 17 00:00:00 2001 From: Nathan Cutler Date: Wed, 22 Jan 2025 13:24:49 +0100 Subject: [PATCH] art-obs-beginners-guide,obs_basic_workflow: Reduce duplication Fixes: https://github.com/openSUSE/obs-docu/issues/392 Signed-off-by: Nathan Cutler --- xml/art-obs-beginners-guide.xml | 30 ++++++++++++---------- xml/obs_basic_workflow.xml | 45 +++++---------------------------- 2 files changed, 23 insertions(+), 52 deletions(-) diff --git a/xml/art-obs-beginners-guide.xml b/xml/art-obs-beginners-guide.xml index d9eb6a2..8fb64e7 100644 --- a/xml/art-obs-beginners-guide.xml +++ b/xml/art-obs-beginners-guide.xml @@ -70,23 +70,25 @@ https://www.suse.com/communities/blog/suse-studio-integration/ - Requirements + Dependencies - Packages depend on other packages to function properly. - There are two types of requirements: - build requirements and - installation requirements. + Packages depend on other packages to function properly. These + relationships are referred to as "dependencies". + There are two types of dependencies: + build dependencies and + runtime dependencies. + Build dependencies are packages that must be present at build time + in order to successfully build your source package. The act of building + your source package will create one or more binary packages. Each binary + package can specify some number of runtime dependencies (packages that + your software needs to be present at runtime), and the package + manager will try to install these together with your package. + Both types of dependencies - build and runtime - are specified in the + build recipe. Exactly how this is done is described in the documentation + of the build system (RPM, Debian, etc.) in question and is beyond the + scope of this &obs; documentation. - - Build requirements are dependencies which are needed during the - build process in &obsa;. For example, a C++ program needs - a C++ compiler. - - - Installation requirements are dependencies which are needed when installing - the final package. - diff --git a/xml/obs_basic_workflow.xml b/xml/obs_basic_workflow.xml index 20f233d..9a8b7ed 100644 --- a/xml/obs_basic_workflow.xml +++ b/xml/obs_basic_workflow.xml @@ -513,30 +513,18 @@ Fri Aug 23 08:42:42 UTC 2017 - &exampleuser_mail; - Adding Dependencies to Your Project + Dependency Handling in Your Projects - Software usually depends on other software: To run an application, you - may, for example, need additional libraries. Such dependencies are called - installation requirements. - - - Firstterm for installation req/build req? - sknorr, 2017-08-24 - - - Additionally, there are also dependencies that are only necessary for - building a package but not when the software it contains is run. Such - dependencies are called build requirements. + As described in more detail in , both types + of package dependencies (build and runtime) are specified in the build + recipe, and exactly how this is done is beyond the scope of this &obs; + documentation. - The &obs; provides the following methods to handle both dependencies in - your projects: + The &obs; provides the following methods to handle both types of + dependencies (build and runtime) in your projects: - - - - - @@ -551,25 +539,6 @@ Fri Aug 23 08:42:42 UTC 2017 - &exampleuser_mail; - - Adding Dependencies to Your Build Recipes - toms 2017-08-24: Should probably go into the concept part? - toms 2017-08-24: should we explain hard and soft requirements? - - In a spec file, dependencies are expressed with the keywords Requires - (installation requirements) and BuildRequires (installation - requirements). Both belong to the header of the spec file. - - - Excerpt of Build and Installation Requirements - Name: foo-example -Version: 1.0.0 -BuildRequires: bar -Requires: zool >= 1.5.6 - - toms 2017-08-24: Version compare with zypper vcmp? - Associating Other Repositories with Your Repository