From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id C843E158086 for ; Wed, 13 Oct 2021 13:42:10 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id DB2C3E0839; Wed, 13 Oct 2021 13:42:09 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id B2480E0839 for ; Wed, 13 Oct 2021 13:42:09 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 949C33434F4 for ; Wed, 13 Oct 2021 13:42:08 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 10D1A10A for ; Wed, 13 Oct 2021 13:42:07 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1634132435.42652857e3b5592b2001f13b041e66c341007ebe.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: keywording/ X-VCS-Repository: proj/devmanual X-VCS-Files: keywording/text.xml X-VCS-Directories: keywording/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 42652857e3b5592b2001f13b041e66c341007ebe X-VCS-Branch: master Date: Wed, 13 Oct 2021 13:42:07 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 6f5f8766-d8bb-45b4-927d-a76aabaf2c05 X-Archives-Hash: 2c535d18174d24bf9d3af5b0cc900362 commit: 42652857e3b5592b2001f13b041e66c341007ebe Author: Joonas Niilola gentoo org> AuthorDate: Sun Oct 10 10:03:33 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Wed Oct 13 13:40:35 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=42652857 keywording: wrap text at 80 chars Signed-off-by: Joonas Niilola gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> keywording/text.xml | 71 +++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 35 deletions(-) diff --git a/keywording/text.xml b/keywording/text.xml index 159d746..74bca5d 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -5,10 +5,10 @@ -Terminology: The term 'package' refers to an entire directory, for example -app-editors/vim it does not refer to a specific version. The terms -'ebuild' or 'package version' are used when this meaning is intended. This -distinction is important. +Terminology: The term 'package' refers to an entire directory, for +example app-editors/vim it does not refer to a specific +version. The terms 'ebuild' or 'package version' are used when this meaning is +intended. This distinction is important.

@@ -41,8 +41,8 @@ The different levels of keyword are: arch (x86, ppc-macos) ("stable")

- Both the package version and the ebuild are widely tested, known to work - and not have any serious issues on the indicated platform. + Both the package version and the ebuild are widely tested, known to + work and not have any serious issues on the indicated platform.
~arch (~x86, ~ppc-macos) ("testing") @@ -72,9 +72,10 @@ The different levels of keyword are:

-The -* keyword is special. It is used to indicate package versions which are -not worth trying to test on unlisted arches. For example, a binary-only package -which is only supported upstream on ppc and x86 might use: +The -* keyword is special. It is used to indicate package versions which +are not worth trying to test on unlisted arches. For example, a binary-only +package which is only supported upstream on ppc and x86 might +use:

@@ -103,23 +104,23 @@ do not specify a KEYWORDS variable.

-An ebuild must not depend upon any package that is of a lower keyword level -than itself. For example, if foo-1.2 depends upon bar-1.2, and -bar-1.2 is ~x86, then foo-1.2 must not be marked stable on -x86 unless bar-1.2 is also stabilised. +An ebuild must not depend upon any package that is of a lower keyword +level than itself. For example, if foo-1.2 depends upon bar-1.2, +and bar-1.2 is ~x86, then foo-1.2 must not be marked +stable on x86 unless bar-1.2 is also stabilised.

-You may assume that if a user accepts ~arch for a given arch then they also -accept arch. +You may assume that if a user accepts ~arch for a given arch then they +also accept arch.

-For optional dependencies, all possible dependencies must satisfy the above. -Note that certain USE flags can be forcibly disabled on a per-profile basis - talk to the arch teams if you require this. For either-or dependencies, at -least one of the options must be of equal or better visibility than the -package in question. +For optional dependencies, all possible dependencies must satisfy the +above. Note that certain USE flags can be forcibly disabled on a +per-profile basis talk to the arch teams if you require this. For +either-or dependencies, at least one of the options must be of equal or +better visibility than the package in question.

@@ -139,10 +140,10 @@ packages.

The only time it is acceptable for a user to see the Possibly a DEPEND -problem error message is if they have manually changed visibility levels for a -package (for example, through /etc/portage/) and have missed a dependency. -You should never commit a change which could cause this error to appear on a -user system. +problem error message is if they have manually changed visibility levels for +a package (for example, through /etc/portage/) and have missed a +dependency. You should never commit a change which could cause this error to +appear on a user system.

@@ -162,12 +163,12 @@ a keywording bug instead for non-amd64/x86.

Do not assume that your package works on all architectures. Do not -assume that user submitted ebuilds will have correct KEYWORDS chances are -they just copied from somewhere else. Do not assume that upstream's -'supported architectures' list is correct. Do not assume that because your -code is written in Perl / Python / Java / whatever that it will run on other -arches (there is at least one case of a vim script which only worked on -x86). +assume that user submitted ebuilds will have correct KEYWORDS +chances are they just copied from somewhere else. Do not assume that +upstream's 'supported architectures' list is correct. Do not assume that +because your code is written in Perl / Python / Java / whatever that it will run +on other arches (there is at least one case of a vim script which only +worked on x86).

@@ -327,8 +328,8 @@ for further details): The package version must be widely tested.

  • - If the package is a library, it should be known not to break any package which - depends upon it. + If the package is a library, it should be known not to break any package + which depends upon it.
  • @@ -443,9 +444,9 @@ any given keyword level on any profile. The aim here is:
    • Never to force a downgrade. (Exception: occasionally you really do want to - force a downgrade, for example if the newly committed foo-1.3 turns out - to be badly broken and that making everyone downgrade to foo-1.2 is the - better option. This is rare.) + force a downgrade, for example if the newly committed foo-1.3 turns + out to be badly broken and that making everyone downgrade to foo-1.2 + is the better option. This is rare.)
    • Do not break any existing dependencies.