Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
...
* Makefile: use rsvg-convert to generate PNGs from SVGs.Michael Orlitzky2020-01-271-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | Our Makefile currently uses inkscape (via imagemagick's "convert" wrapper) to turn SVGs into PNGs. This has a few downsides: * media-gfx/inkscape is a huge dependency, * inkscape is slow to perform the conversion, * installing imagemagick[svg] doesn't ensure that "convert" can convert an SVG to a PNG if inkscape is missing (bug 684686). The good news is that there is another SVG -> PNG conversion tool called rsvg-convert that is installed by gnome-base/librsvg. Compared to inkscape, librsvg is a light dependency and rsvg-convert is lightning-fast. Moreover, installing gnome-base/librsvg guarantees that the latter will exist and can actually perform the conversion. Inkscape is supposedly more powerful, but so far in the devmanual we're only using SVG to put words in boxes. The simpler tool is sufficient for that, and therefore preferable. This commit updates the Makefile to use rsvg-convert. Bug: https://bugs.gentoo.org/684686 Closes: https://bugs.gentoo.org/700904 Signed-off-by: Michael Orlitzky <mjo@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: add prereq check for the Open Sans font.Michael Orlitzky2020-01-271-0/+3
| | | | | | | | | | | | | The fc-list command from media-libs/fontconfig can tell us what fonts are available to rsvg-convert, so this commit asks it if any font matching the pattern "Open Sans" is installed. You could make this check a bit more bullet-proof by checking the exact string (to avoid matching e.g. Not Open Sans), but only at the expense of making a simple command more complicated. Bug: https://bugs.gentoo.org/700904 Signed-off-by: Michael Orlitzky <mjo@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* *.svg: specify Open Sans instead of generic "sans-serif" font.Michael Orlitzky2020-01-275-920/+1727
| | | | | | | | | | | | | | | | 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>
* general-concepts: Restore alphabetical order of includes.Ulrich Müller2020-01-251-2/+3
| | | | | | | Fixes: 4a88709ecea8b25dce3063b3b8454b870f1435d9 Fixes: 8c1cb7c99809541c4782055a1591155f5e7749a2 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Add developer stabilization exception for AMD64/X86 arches.Tom Wijsman2020-01-251-0/+7
| | | | | | | | | | | References: - "AMD64 keywording" thread by kingtaco on the gentoo-core mailing list (2007) - app-emacs stabilization talk by kingtaco and ulm on IRC #gentoo-dev (2007) - Gentoo Council agenda item: "amd64 arch team and big bug list" (2008/03/13) Closes: https://bugs.gentoo.org/510198 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Include sections about stabilization.Ulrich Müller2020-01-253-134/+69
| | | | | | | | | Remove the ebuild-maintenance/stabilization section (which resulted from the split of ebuild-maintenance/maintenance-tasks), and include it in keywording. Delete duplicate and outdated information. Closes: https://bugs.gentoo.org/648316 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>
* keywording: Follow the terminology defined at start of the section.Ulrich Müller2020-01-231-10/+11
| | | | | Closes: https://bugs.gentoo.org/567312 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* quickstart: Generalize note about HOMEPAGE.Ulrich Müller2020-01-231-1/+1
| | | | | Closes: https://bugs.gentoo.org/533552 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance: Delete dead include.Ulrich Müller2020-01-231-1/+0
| | | | | Fixes:450692994d68bed141e324284ac9be671f8c84bf Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/package-and-slot-moves: Update package movesMichał Górny2020-01-231-67/+27
| | | | | | | | | | | | | Update the text on package moves to cover the case when PN changes as well as category. Cover necessary changes in moved ebuild. Switch from wall-of-text block into a more readable list. Move additional points from examples to this list. Finally, remove the example that now pretty much repeats what was said above. Signed-off-by: Michał Górny <mgorny@gentoo.org> [Clarification added by committer to first paragraph of "Moving or renaming a package".] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/package-and-slot-moves: Add extra warningsMichał Górny2020-01-231-1/+21
| | | | | | | | Since people are frequently getting moves wrong, try to point out a few important limitations. Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/maintenance-tasks: Drop "Homepage unavailable" section.Ulrich Müller2020-01-233-36/+11
| | | | | | | | | | | 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/collisions: New chapter.Ulrich Müller2020-01-233-47/+50
| | | | | | Split off from ebuild-maintenance/maintenance-tasks. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/removal: New chapter.Ulrich Müller2020-01-233-83/+90
| | | | | | Split off from ebuild-maintenance/maintenance-tasks. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/stabilization: New chapter.Ulrich Müller2020-01-233-111/+120
| | | | | | Split off from ebuild-maintenance/maintenance-tasks. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/new-ebuild: New chapter.Ulrich Müller2020-01-234-125/+128
| | | | | | Split off from ebuild-maintenance/maintenance-tasks. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance: Move package & slot moves into sep chapterMichał Górny2020-01-233-120/+135
| | | | | | Signed-off-by: Michał Górny <mgorny@gentoo.org> [Fixed guide tag, use title case for chapter title.] 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-234-30/+42
| | | | | | | | | - 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-2310-294/+113
| | | | | | | | | | | | | | | | - 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>
* general-concepts/dependencies: Drop section on if-else USE blocks.Ulrich Müller2020-01-231-30/+0
| | | | | | | If-else USE blocks, i.e. "Legacy Inverse USE-Conditional Dependency Syntax", have been abandoned before EAPI was introduced. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=1 information to other sections.Ulrich Müller2020-01-233-75/+28
| | | | | | | | - 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>
* devmanual.css: Indent <dd> in definition lists.Ulrich Müller2020-01-221-0/+1
| | | | | | | The Bootstrap layout indents <li> but leaves <dd> flush-left (why?). Add a 2em left margin for <dd> so it will be indented. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Load devmanual.css stylesheet last.Ulrich Müller2020-01-222-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Remove tcolumn element.Ulrich Müller2020-01-212-9/+2
| | | | | | | | | | | | Not clear what the original intention of this was, but: - <tcolumn> was never used in the devmanual. - The generated HTML would have been invalid, because it contained <col> without an enclosing <colgroup>. - The width attribute is deprecated in HTML 4 and obsolete in HTML 5. Remove for now from devbook.xsl; update devbook.dtd accordingly. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Don't indent <pre> and <codesample>.Ulrich Müller2020-01-182-36/+35
| | | | | | | 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-184-5/+5
| | | | | | Also normalise whitespace around <d/> in some places in the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: More postprocessing for man2html.Ulrich Müller2020-01-181-0/+3
| | | | | | In order to silence the W3C Validator. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Don't include "Reference" in link texts.Ulrich Müller2020-01-161-1/+1
| | | | | | | This was redundant and inconsistent with the text generated by the XSL stylesheet. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* appendices/contributors: Drop attribution for auto-generated page.Ulrich Müller2020-01-161-2/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "Fixed eclass-reference links"Ulrich Müller2020-01-166-12/+12
| | | | | | | | | | 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>
* devbook.xsl: Fix links to eclass references.Ulrich Müller2020-01-161-0/+6
| | | | | Closes: https://bugs.gentoo.org/442194 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Drop redundant subsection levels.Ulrich Müller2020-01-161-6/+1
| | | | | | | | Guide XML allowed body elements only at the lowest section level. DevBook XML doesn't have that strict rule, therefore we can drop the unnecessary intermediate levels. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Remove obsolete text in "<uri>" subsection.Ulrich Müller2020-01-151-11/+5
| | | | | | | | | Linking to other parts of the Gentoo web site doesn't apply to us, because the devmanual isn't at www.gentoo.org. Consistently have a trailing slash in example URIs. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Typo.Ulrich Müller2020-01-151-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Update "Internal Coding Style" section.Ulrich Müller2020-01-151-10/+11
| | | | | | Describe only the tags that are actually used in DevBook XML. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Rename from "GuideXML guide" to "DevBook XML guide".Ulrich Müller2020-01-151-17/+17
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use source form of URI fragment identifiers throughout.Ulrich Müller2020-01-159-15/+15
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Section on including sub-documents.Ulrich Müller2020-01-151-0/+27
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Update section on intra-document references.Ulrich Müller2020-01-151-8/+17
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* xsl/lang.highlight.c.xsl: Define the myPos variable.Ulrich Müller2020-01-151-0/+1
| | | | | | | | | | | | This was undeclared, leading to a runtime error: runtime error: file xsl/lang.highlight.c.xsl line 35 element variable Variable 'myPos' has not been declared. XPath error : Undefined variable runtime error: file xsl/lang.highlight.c.xsl line 35 element variable Failed to evaluate the expression of variable 'quotePos'. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Explain <codesample>.Ulrich Müller2020-01-151-4/+65
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Make codesamples agree with their rendering.Ulrich Müller2020-01-151-15/+20
| | | | | | Mention <figure> and <codesample> as subelements of <body>. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Update basic document structure for DevBook XML.Ulrich Müller2020-01-151-99/+51
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Move directly under appendices.Ulrich Müller2020-01-154-10/+6
| | | | | | | Move one level up, it makes more sense as an own appendix, rather than a sub-document of contributing. 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>
* devmanual.css, devbook.xsl: Drop td.devbook.Ulrich Müller2020-01-152-5/+1
| | | | | | | | | | | | | | | Use the bootstrap default instead. Custom handling for <th> has already been removed in commit a429f4c, drop it for <ti> as well. About the history of this: The vertical alignment was originally added to resolve bug 53500, see the variables table (e.g. the KEYWORDS line) in the archived page: https://web.archive.org/web/20040604000628/http://www.gentoo.org/doc/en/gentoo-howto.xml The class was later (commit cff18db) renamed from tableinfo to devbook. None of this seems to be necessary any more; vertical alignment is just fine with the bootstrap layout. Signed-off-by: Ulrich Müller <ulm@gentoo.org>