Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
path: root/ebuild-writing
Commit message (Collapse)AuthorAgeFilesLines
* ebuild-writing/functions/src_unpack/vcs-sources: KEYWORDS must be empty.Ulrich Müller2020-02-221-4/+5
| | | | | | | Update policy on live ebuilds, as discussed in gentoo-dev: https://archives.gentoo.org/gentoo-dev/message/a4cc194fc387d4abffed054b523d83f8 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_unpack/vcs-sources: Remove CVS and SVN sections.Ulrich Müller2020-02-221-183/+0
| | | | | | This is documented in the eclasses themselves, to which we refer. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_unpack/vcs-sources: New file.Ulrich Müller2020-02-225-309/+285
| | | | | | | cvs-sources and svn-sources contain duplicate information, and it also applies to other VCSs. Combine them in a single chapter. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Sync example phase functions from PMS.Ulrich Müller2020-02-203-8/+8
| | | | | | | This follows the recent PMS update: https://gitweb.gentoo.org/proj/pms.git/commit/?id=0d4ffd51d3dc86782dae2db9fe632f45af7eec87 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/slotting: Clarify that SLOT must not be empty.Ulrich Müller2020-02-181-2/+2
| | | | | | | | | Not sure from where the concept "an empty slot means disable slotting" originated. In any case, it is wrong, and it was not legal in any EAPI. Update the SLOT section in ebuild-writing/variables, too. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Replace ">" by "&gt;" throughout.Ulrich Müller2020-02-183-4/+4
| | | | | | | Most instances are already being escaped, so convert the few remaining ones for consistency throughout the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove unnecessary escaping of quotes.Ulrich Müller2020-02-161-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=4 information to other sections.Ulrich Müller2020-02-119-352/+204
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Utilities die, nonfatal: New section in ebuild-writing/error-handling, new chapter function-reference/error-functions - dodoc -r: Already in function-reference/install-functions, add additional example to ebuild-writing/functions/src_install - doins symlink support: Incorporated into function-reference/install-functions - dosed, dohard banned: Not mentioned anywhere else - econf --disable-dependency-tracking: New section about econf options in ebuild-writing/functions/src_configure/configuring - Controllable compression and docompress: New chapter ebuild-writing/functions/src_install/docompress - USE dependency defaults: Incorporated into general-concepts/dependencies - pkg_pretend: Already in ebuild-writing/functions/pkg_pretend - default src_install: Already in ebuild-writing/functions/src_install - pkg_info: Incorporated into ebuild-writing/functions/pkg_info - REQUIRED_USE: Already in ebuild-writing/variables - MERGE_TYPE, REPLACING_VERSIONS, REPLACED_BY_VERSION: Moved to ebuild-writing/variables - DOCS: Incorporated into ebuild-writing/variables - AA, KV removed: Not mentioned anywhere else - RDEPEND=DEPEND: Already handled in commit 5a946b4 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* *.svg: specify Open Sans instead of generic "sans-serif" font.Michael Orlitzky2020-01-271-253/+224
| | | | | | | | | | | | | | | | The text in most of our diagrams was left to use the generic "sans-serif" font face, which depends on both the local machine and the program used to edit/convert the SVG image. This isn't the best situation, because we want the output PNGs to be predictable. The Tyrian layout used for devmanual.gentoo.org makes heavy use of the "Open Sans" font, so this commit updates each SVG in the devmanual to use that face for all text elements that were previously "sans-serif". Bug: https://bugs.gentoo.org/700904 Signed-off-by: Michael Orlitzky <mjo@gentoo.org> [Fonts in ebuild-writing/functions/diagram.svg fixed] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/users-and-groups: Use example ebuilds from tree.Ulrich Müller2020-01-231-13/+9
| | | | | | | | | | | | | | | The acct-user/group ebuilds for suricata are rather typical examples, so replace the fictitious user 123 by them. This also has ${PN} as single element in ACCT_USER_GROUPS, and it drops the uncommon ACCT_USER_{SHELL,HOME{,_OWNER,_PERMS}} variables from the example. Original patch from Michael Orlitzky <mjo@gentoo.org> (who asked me to put my own name on it). Closes: https://bugs.gentoo.org/702508 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/maintenance-tasks: Drop "Homepage unavailable" section.Ulrich Müller2020-01-231-6/+6
| | | | | | | | | | | This isn't really a maintenance task. Also, we already mention this twice elsewhere, namely in ebuild-writing/variables and in ebuild-writing/common-mistakes. Update and fix link in the latter. Move the introductory paragraph to the parent document, and remove the chapter which has become empty. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/new-ebuild: New chapter.Ulrich Müller2020-01-231-2/+1
| | | | | | Split off from ebuild-maintenance/maintenance-tasks. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_install: Don't mention old EAPIs.Ulrich Müller2020-01-231-11/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Update introduction, section on EAPIs 0 to 3.Ulrich Müller2020-01-231-13/+34
| | | | | | | Modernise the introduction, and add a short section saying that EAPIs 0 to 3 are obsolete. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=3 information to other sections.Ulrich Müller2020-01-233-26/+41
| | | | | | | | | - Prefix support: Reference to Prefix documentation moved to ebuild-writing/variables - unpack .xz support: Add list of recognized unpack formats in ebuild-writing/functions/src_unpack Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/metadata: Explain EAPI 0 atom.Ulrich Müller2020-01-231-3/+4
| | | | | | | Since EAPIs 0 to 2 are no longer mentioned, we need to explain what an "EAPI=0 package dependency specification" is. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=2 information to other sections.Ulrich Müller2020-01-237-264/+71
| | | | | | | | | | | | | | | | - doman language support: incorporated into function-reference/install-functions - Blockers incorporated into general-concepts/dependencies (also say "weak" and "strong" blockers instead of "soft" and "hard", in order to agree with the terms used in PMS) - USE dependencies: already in general-concepts/dependencies - SRC_URI arrows: incorporated into ebuild-writing/variables - src_prepare: already in ebuild-writing/functions/src_prepare - src_configure: already in ebuild-writing/functions/src_configure - Execution order: already in ebuild-writing/functions - Default phase functions moved to ebuild-writing/functions Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=1 information to other sections.Ulrich Müller2020-01-231-70/+0
| | | | | | | | - Default src_compile: already in ebuild-writing/functions/src_compile - SLOT dependencies: already in general-concepts/dependencies - IUSE defaults moved to general-concepts/use-flags Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Don't indent <pre> and <codesample>.Ulrich Müller2020-01-181-33/+32
| | | | | | | Whitespace before the closing tag is significant and would show up in html output. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Suppress spurious newlines for <d/>.Ulrich Müller2020-01-181-1/+1
| | | | | | Also normalise whitespace around <d/> in some places in the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "Fixed eclass-reference links"Ulrich Müller2020-01-164-9/+10
| | | | | | | | | | This is now fixed in devbook.xsl, so the changes in the text (which were meant as a stop-gap measure) can be reverted again. This reverts commit 481c88ea7ca8d93b17ac6668186216baf50daab9. Bug: https://bugs.gentoo.org/475332 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use source form of URI fragment identifiers throughout.Ulrich Müller2020-01-156-11/+11
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_unpack/svn-sources: Typo.Ulrich Müller2020-01-151-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/.../metadata: clarify that upstream maintainer takes no 'type'Göktürk Yüksek2020-01-141-0/+2
| | | | | | Closes: https://bugs.gentoo.org/703626 Closes: https://github.com/gentoo/devmanual/pull/140 Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* Update redirected links.Ulrich Müller2020-01-101-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix broken internal links.Ulrich Müller2020-01-092-7/+8
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update some external links.Ulrich Müller2020-01-091-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_install: Don't mention einstall.Ulrich Müller2020-01-091-7/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Fix link to Prefix Technical Documentation.Ulrich Müller2020-01-091-1/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Make (sub-)section titles unique within each chapter.Ulrich Müller2020-01-042-38/+40
| | | | | | | | | | | | | | | | Section, subsection, etc. titles are used to construct ID attributes, which must be unique within each chapter. One approach to disambiguate these identifiers would be to use the complete section hierarchy for constructing them (see bug 626032). However, that would break external references (and for example, links from bugzilla or from mailing list archives cannot be updated). Use a less intrusive approach instead and make the titles of the few ambiguous subsections unique, or convert them to a list. Closes: https://bugs.gentoo.org/626032 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright years.Ulrich Müller2020-01-026-9/+9
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/users-and-groups: post-merge enhancementsGöktürk Yüksek2019-12-261-6/+8
| | | | Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* ebuild-writing/users-and-groups: Update policyMichał Górny2019-12-261-12/+17
| | | | | | Closes: https://github.com/gentoo/devmanual/pull/125 Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* Remove all p elements below dd.Ulrich Müller2019-12-261-6/+6
| | | | | | Where necessary, use multiple dd elements instead. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Replace <path> by <c> throughout.Ulrich Müller2019-12-262-12/+12
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/users-and-groups: Fix document structure.Ulrich Müller2019-12-101-0/+5
| | | | | | Fixes: 9613e9e69ae16e6981f90135f92811ded641b52c Acked-by: Göktürk Yüksek <gokturk@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/users-and-groups: GLEP 81 user data guidelines.Michael Orlitzky2019-12-091-0/+169
| | | | | | | | | | | | | | | | | | | | | | | GLEP 81 significantly changes the way that user management is handled, and reveals some subtle issues in existing packages that have remained hidden until now. Many of these issues can be avoided (in GLEP 81, but also in general) by exercising some discipline when choosing the data for new users and groups: * User and group names * Default shell * Home directory * Home directory ownership and permissions This commit adds a few new sections to the "Users and Groups" chapter that explain the current best practices, and give suggestions for choosing the user and group data listed above. The rationale for these choices is explained, and some notable exceptions are mentioned. Closes: https://bugs.gentoo.org/693964 Closes: https://github.com/gentoo/devmanual/pull/116 Signed-off-by: Michael Orlitzky <mjo@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* Element <i> in <pre> or <codesample> is not supported.Ulrich Müller2019-12-081-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use <d/> for dashes throughout.Ulrich Müller2019-12-082-5/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Drop caption attribute from <pre> elements.Ulrich Müller2019-12-082-5/+5
| | | | | | This isn't processed by devbook.xsl and doesn't show up in the output. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Element <br> is not supported.Ulrich Müller2019-12-083-14/+18
| | | | | | Replace by paragraph break, or drop. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Elements <brite>, <mail>, and <pkg> are not supported.Ulrich Müller2019-12-081-49/+46
| | | | | | | Use <c> instead, which seems to be the most appropriate replacement in their respective contexts. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix nesting of elements.Ulrich Müller2019-12-086-25/+22
| | | | | | | | - Lists inside <p> are not allowed. - <ul> is not a direct child of <ul>; it must be inside <li>. - <p>, <note>, etc. are no children of <p>. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix <body> elements.Ulrich Müller2019-12-086-34/+31
| | | | | | | No sectioning elements are allowed inside <body>, according to the devbook guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/error-handling: expand subshell warning to EAPI=7Mikle Kolyada2019-12-021-1/+1
| | | | | Closes: https://github.com/gentoo/devmanual/pull/90 Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* ebuild-writing/variables: Typo.Ulrich Müller2019-11-291-1/+1
| | | | | Fixes: dabb1f76df1fe26cdf1b79d235b4ee3f0a9464cb Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/variables: update the paragraph about trailing slashesGöktürk Yüksek2019-11-281-13/+8
| | | | | | | | | | The information dates back to pre-EAPI7 era and incorrectly states that ROOT etc. always end with a trailing slash, which is incorrect with EAPI7. Update the text to reflect both EAPI7 and pre-EAPI7 practices and suggest the bash suffix removal for pre-EAPI7 ebuilds to ease transition. Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* ebuild-writing/variables: fix the trailing slash in ROOT for EAPI7Göktürk Yüksek2019-11-281-4/+4
| | | | | | | | Before EAPI7, ROOT was guaranteed to end with a trailing slash. EAPI7 reversed this. Add back trailing slashes to ROOT in the example. Reported-by: Conrad Kostecki <conrad@kostecki.com> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* ebuild-writing/variables: explicitly discourage HOMEPAGE in SRC_URIMichał Górny2019-11-251-0/+5
| | | | | | Closes: https://github.com/gentoo/devmanual/pull/115 Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* ebuild-writing/variables: Indicate that HOMEPAGE is multi-valuedMichał Górny2019-11-251-5/+6
| | | | | | | | | | | | Indicate that HOMEPAGE can accept multiple values. Expand freshmeat fallback suggestion into the broader idea that package trackers can be linked in addition to main HOMEPAGE (which is a common practice e.g. for Python packages). Simplify No_homepage suggestion to always use it when there's no homepage, rather than when transitioning from old homepage. Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>