From 833f8697bdab509870b5013f8b7e6d5233e4f600 Mon Sep 17 00:00:00 2001 From: Nathan Cutler Date: Fri, 30 Aug 2024 13:50:35 +0200 Subject: [PATCH] art-obs-beginners-guide.xml: address terminology confusion The word "project" has a special meaning in the OBS context, so let's be careful when using it in the OBS documentation. Signed-off-by: Nathan Cutler --- xml/art-obs-beginners-guide.xml | 48 ++++++++++++++++----------------- 1 file changed, 23 insertions(+), 25 deletions(-) diff --git a/xml/art-obs-beginners-guide.xml b/xml/art-obs-beginners-guide.xml index 27e74ca..d9eb6a2 100644 --- a/xml/art-obs-beginners-guide.xml +++ b/xml/art-obs-beginners-guide.xml @@ -25,8 +25,8 @@ https://www.suse.com/communities/blog/suse-studio-integration/ This guide describes basic workflows for working with packages on - &obs;. This includes checking out a package from an upstream project, - creating patches, branching a repository, and more. + &obs;. This includes checking out an upstream package from a public + source code repository, creating patches, branching a repository, and more. @@ -162,7 +162,7 @@ https://www.suse.com/communities/blog/suse-studio-integration/ Projects can also have other projects (subprojects) to structure work. - They are isolated from their parent project and can be configured + They are mostly isolated from their parent project and can be configured individually. @@ -302,8 +302,8 @@ https://www.suse.com/communities/blog/suse-studio-integration/ - An example upstream open source project available at . This project contains source code in the C++ programming language. + An example upstream open source repository at . This repository contains source code in the C++ programming language. @@ -323,7 +323,7 @@ https://www.suse.com/communities/blog/suse-studio-integration/ - Creating packages from a basic project hosted on &gh;. + Creating packages from a repository hosted on &gh;. @@ -513,22 +513,20 @@ Cmnd_Alias OSC_CMD = /usr/bin/osc, /usr/bin/build - Creating a New Project + Creating a New Package Within Your Home Project - This section demonstrates how to create packages from a simple C++ project - hosted on &gh; (the upstream project). We assume that this - project contains source code which you want to package for different - &suse; distributions. + This section demonstrates how to create packages for different &suse; distributions + from some simple C++ source code hosted on &gh; (the upstream repository). Check the License First - Before building, go to the homepage of the upstream project and check the + Before building, go to the upstream homepage or documentation and check the license. - For example, in the &osbs;, you must only redistribute packages which are - available under an open source license. + For example, in the &osbs;, you may only redistribute source code which was + distributed to you under an open source license. If you are submitting a package to &opensuse;, its source code will be checked for license compliance. If your package is not released under an open source license, it will be rejected. @@ -543,11 +541,11 @@ Cmnd_Alias OSC_CMD = /usr/bin/osc, /usr/bin/build - To create a package from the upstream project, follow the steps below. + To create a package from the upstream repository, follow the steps below. - Set up your project as shown in . + Set up your home project as shown in . @@ -575,17 +573,17 @@ Cmnd_Alias OSC_CMD = /usr/bin/osc, /usr/bin/build - Get the source code of the upstream project and save it in + Get the source code from the upstream repository and save it in &obsworkdir1;/&sampleprj;. Download a TAR archive of the sources. You do not have to unpack it yet. - In our example, the project is hosted on &gh; and you can use the + In our example, the upstream repository is hosted on &gh; and you can use the following URL: . - If there is no published release of a project, click the Clone or + If there is no published release, click the Clone or download button and download the latest sources using the Download ZIP link. @@ -796,8 +794,8 @@ openSUSE_Tumbleweed x86_64 *.spec--> Patching Source Code - This section describes how to patch an upstream project. We use the same - project as shown in . + This section describes how to tell &obs; to apply a patch to your package + before building it. We use the same package as shown in . There are different reasons for patching a package. @@ -807,14 +805,14 @@ openSUSE_Tumbleweed x86_64 *.spec--> You Do Not Have Permission to Commit Upstream - Often, you cannot commit changes directly to the upstream project. - If you send changes to the upstream project, they may be integrated + Often, you cannot commit changes directly to the upstream repository. + If you send changes to the upstream repository, they may be integrated late or even be rejected. - Patch files allow making changes while keeping source code clean and also - allow independence from an upstream project's release cycle, coding + Patch files allow making changes while keeping source code clean while + insulating your package from upstream's release cycle, coding style, and internal workings.