[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/, ebuild-maintenance/maintenance-tasks/, ...

2020-01-22 Thread Ulrich Müller
commit: cb01d9ebc777517fce784dde4f8cdbf78d91b5bf
Author: Ulrich Müller  gentoo  org>
AuthorDate: Tue Jan 21 10:34:07 2020 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Thu Jan 23 07:48:05 2020 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=cb01d9eb

ebuild-maintenance/new-ebuild: New chapter.

Split off from ebuild-maintenance/maintenance-tasks.

Signed-off-by: Ulrich Müller  gentoo.org>

 ebuild-maintenance/maintenance-tasks/text.xml | 123 -
 ebuild-maintenance/new-ebuild/text.xml| 126 ++
 ebuild-maintenance/text.xml   |   1 +
 ebuild-writing/common-mistakes/text.xml   |   3 +-
 4 files changed, 128 insertions(+), 125 deletions(-)

diff --git a/ebuild-maintenance/maintenance-tasks/text.xml 
b/ebuild-maintenance/maintenance-tasks/text.xml
index b5b7359..972b7b3 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/maintenance-tasks/text.xml
@@ -11,129 +11,6 @@ developers may not be familiar with.
 
 
 
-
-Adding a new ebuild
-
-
-What (not) to put in the Gentoo repository
-
-
-
-Before writing a new ebuild, check
-https://bugs.gentoo.org/";>bugs.gentoo.org
-to see if an ebuild has already been written for the package, but has not yet
-been added to the Gentoo repository.  Go to https://bugs.gentoo.org/";>bugs.gentoo.org, choose query and select
-Advanced Search; as product select Gentoo Linux, as component select
-ebuilds.  In the search field put the name of the ebuild and as status
-select all possible fields, then submit the query. For you lazy people, click
-https://bugs.gentoo.org/query.cgi?format=advanced&product=Gentoo%20Linux&component=New%20Ebuilds&bug_Status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=RESOLVED&bug_status=VERIFIED";>here.
-
-
-
-In general, the Gentoo repository should only be used for storing
-.ebuild files, as well as any relatively small companion
-files, such as patches or sample configuration files. These types of
-files should be placed in the mycat/mypkg/files directory
-to keep the main mycat/mypkg directory uncluttered.
-Exceptions to this rule are for larger patch files (we recommend this
-for patches above 20KB) which should be distributed as tarballs via the
-Gentoo
-mirror system so that people do not waste excessive amounts of
-bandwidth and hard drive space. Also, you should not add binary
-(non-ASCII) files to the git tree. Also, speaking of merging changes,
-any patches you add to Portage should generally not be
-compressed. This will allow git to merge changes and correctly inform
-developers of conflicts.
-
-
-
-Remember, the packages that you commit must be ready out of the
-box for end users when committed as stable.  Make sure that you have a good
-set of default settings that will satisfy the majority of systems and
-users that will use your package.  If your package is broken, and you are
-not sure how to get it to work, check some other distributions that have
-done their own versions of the package.  You can check
-https://www.debian.org/distrib/packages";>Debian or
-https://src.fedoraproject.org/projects/rpms/*";>Fedora for some
-examples.
-
-
-
-When committing to git, all developers should use repoman commit
-instead of git commit to submit their ebuilds.  Before committing,
-please run repoman full to make sure you didn't forget something.
-
-
-
-
-
-
-Initial Architecture Keywords
-
-
-When adding a new ebuild, you should only include KEYWORDS for
-architectures on which you have actually tested the ebuild, confirming
-that it works as it should and that USE flags are properly
-honoured in the resulting package which would be installed. If
-possible, you should give the actual library or application thorough
-testing as well, since you would be responsible for any breakages for
-your architecture(s). Minimal testing such as checking that the
-application starts up without any errors should always be performed.
-
-
-
-If you are adding a user-submitted ebuild, do not assume that the
-submitter has done testing on various architectures: often, KEYWORDS
-are cloned across packages or generated from documentation in the
-source packages, which does not signify that the package does indeed
-work on those architectures.
-
-
-
-
-
-
-The files Directory
-
-
-
-As noted earlier, under each package subdirectory is
-a files/ directory. Any patches, configuration files, or
-other ancillary files your package might require should be added to
-this directory; any files bigger than 20KB-or-so should go to the
-mirrors to lower the amount of (unneeded) files our users have to
-download. You may want to consider naming patches you create yourself
-just to get your package to build with a version-specific name, such
-as mypkg-1.0-gentoo.diff, or more
-simply, 1.0-gentoo.diff.  Also note that the
-gentoo extension informs people that this patch was created
-by us, the Gentoo Linux developers, ra

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/, ebuild-maintenance/maintenance-tasks/

2019-06-17 Thread Ulrich Müller
commit: 07452705c2b149c0510d64c72dc9e474bd0f8363
Author: Ulrich Müller  gentoo  org>
AuthorDate: Mon Jun 17 19:51:59 2019 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Mon Jun 17 19:51:59 2019 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=07452705

Avoid absolute (and outdated) /usr/portage path.

Signed-off-by: Ulrich Müller  gentoo.org>

 ebuild-maintenance/maintenance-tasks/text.xml | 9 -
 ebuild-writing/common-mistakes/text.xml   | 4 ++--
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/ebuild-maintenance/maintenance-tasks/text.xml 
b/ebuild-maintenance/maintenance-tasks/text.xml
index a434fb5..06634b8 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/maintenance-tasks/text.xml
@@ -34,11 +34,10 @@ select all possible fields, then submit the query. For you 
lazy people, click
 In general, the Gentoo repository should only be used for storing
 .ebuild files, as well as any relatively small companion
 files, such as patches or sample configuration files. These types of
-files should be placed in the
-/usr/portage/mycat/mypkg/files directory to keep the main
-mycat/mypkg directory uncluttered. Exceptions to this
-rule are for larger patch files (we recommend this for patches above
-20KB) which should be distributed as tarballs via the
+files should be placed in the mycat/mypkg/files directory
+to keep the main mycat/mypkg directory uncluttered.
+Exceptions to this rule are for larger patch files (we recommend this
+for patches above 20KB) which should be distributed as tarballs via the
 Gentoo
 mirror system so that people do not waste excessive amounts of
 bandwidth and hard drive space. Also, you should not add binary

diff --git a/ebuild-writing/common-mistakes/text.xml 
b/ebuild-writing/common-mistakes/text.xml
index 2842531..869676e 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -300,14 +300,14 @@ Another common mistake users make when submitting ebuilds 
is supplying an
 invalid license. For example, GPL is not a valid license. You need to
 specify GPL-1 or GPL-2. Same with LGPL. Make sure the
 license you use in the LICENSE field is something that exists in
-/usr/portage/licenses. As a tip, check the COPYING
+the licenses directory. As a tip, check the COPYING
 in a source tarball for the license. If a package does not specify it
 uses GPL-1 or GPL-2, it is very likely it uses GPL-2.
 
 
 
 If the license for the package you submit is unique and not in
-/usr/portage/licenses/, then you must submit the new license in a
+licenses/, then you must submit the new license in a
 separate file.