Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
path: root/ebuild-writing/common-mistakes/text.xml
Commit message (Collapse)AuthorAgeFilesLines
* Rename the document element from "guide" to "devbook"Ulrich Müller2024-11-091-2/+2
| | | | | | | | | The "guide" document element is ambiguous with the previously used GuideXML format. Now that DevBook XML has a schema, this confuses Emacs nXML mode (which uses the document element to locate a schema), e.g. when visiting old GuideXML documentation files. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix multiple typos and grammatical errorsSebastian Engel2024-08-121-1/+1
| | | | | Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Delete P0 from list of custom variablesUlrich Müller2024-07-241-1/+1
| | | | | | As discussed in #gentoo-qa. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* More sentence case changesUlrich Müller2024-05-071-2/+2
| | | | | | Apparently these have been missed previously. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Sentence case devmanualMatthew Marchese2024-05-071-9/+9
| | | | | | Signed-off-by: Matthew Marchese <maffblaster@gentoo.org> [Whitespace. Fix rebase artifact in ebuild-writing/functions/src_test.] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal linksUlrich Müller2023-10-301-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Explicitly specify UTF-8 encoding in XML declarationsUlrich Müller2022-10-091-1/+1
| | | | | | As specified by the DevBook XML guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove references to repomanMatt Turner2022-03-141-2/+2
| | | | | | Bug: https://bugs.gentoo.org/835013 Closes: https://github.com/gentoo/devmanual/pull/274 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* ebuild-writing/common-mistakes: .diff -> .patchSam James2022-01-221-1/+1
| | | | | | We usually use .patch nowadays so reflect that in the docs. Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: add calling external tools without dieSam James2021-12-221-0/+13
| | | | | | | Suggested-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Sam James <sam@gentoo.org> [Internal cross reference fixed] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: fix formatting of DESCRIPTION/HOMEPAGE noteSam James2021-09-171-0/+2
| | | | | | Reported-by: Ulrich Müller <ulm@gentoo.org> Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Rewrap a long lineUlrich Müller2021-08-141-5/+5
| | | | | Fixes: 947a4714250dfb5d614bce6ef3689b655f235234 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: rewrap paragraphSam James2021-08-011-3/+4
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: reformat 'DESCRIPTION and HOMEPAGE'Sam James2021-08-011-4/+5
| | | | | Closes: https://github.com/gentoo/devmanual/pull/223 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: add 'Calling pkg-config directly'Sam James2021-08-011-1/+22
| | | | | | | | Quite a lot of ebuilds do this. We should instead use the tc-getPKG_CONFIG helper from toolchain-funcs.eclass which respects ${PKG_CONFIG} - useful for e.g. cross-compiling. Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: mention leftover USE flags, inheritsSam James2021-08-011-0/+13
| | | | | Suggested-by: Joonas Niilola <juippis@gentoo.org> (inherits) Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: mention HTTPS for HOMEPAGESam James2021-08-011-1/+2
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: mention using latest EAPISam James2021-08-011-0/+14
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: Fix Gentoo Bugzilla URLUlrich Müller2021-03-301-2/+2
| | | | | | | Warning on previous git push: remote: WARNING: invalid Gentoo Bugzilla URL: https://bugs.gentoo.org/show_bug.cgi?id=werror Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: modernise autotools/econf advice on verbose logSam James2021-03-301-3/+4
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: adjust XML style for build systems listSam James2021-03-301-15/+20
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: slight grammar fixes/phrasing changesSam James2021-03-301-8/+8
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: mention "the compiler", not only GCCSam James2021-03-301-7/+8
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: s/GLIBC/glibc/Sam James2021-03-301-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: linkify bug reference for non-verbose buildsSam James2021-03-301-3/+5
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: build-log -> build logSam James2021-03-301-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: add -Werror tracker linkSam James2021-03-301-0/+2
| | | | | | Bug: https://bugs.gentoo.org/show_bug.cgi?id=werror Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: mention manual Go compiles (verbose builds)Sam James2021-03-301-0/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: s/cmake-utils/cmake/Sam James2021-03-301-3/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: convert 'build log not verbose' to listSam James2021-03-301-14/+14
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: give more information on invalid ${ROOT} usageSam James2021-03-301-2/+5
| | | | | | | Bug: https://bugs.gentoo.org/775191 Signed-off-by: Sam James <sam@gentoo.org> [Add bug number to link text.] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: fix 1st->3rd person per styleSam James2021-03-301-3/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: mention pkgcheckSam James2021-03-301-2/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: extend 'DEPEND is incomplete'Sam James2021-03-291-1/+6
| | | | | | | | Emphasise that the tips/information applies to all dependency classes. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Reformat paragraphs in the -Werror sectionUlrich Müller2021-03-211-11/+33
| | | | | | No change of wording. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* */*: consistent 'Portage' casingSam James2021-03-211-4/+4
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Drop note on Header/Id lineUlrich Müller2021-02-011-7/+0
| | | | | | | This is no longer a common mistake. Exactly the same note is still present in ebuild-writing/file-format. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2021-01-031-1/+1
| | | | 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>
* 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-091-4/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright years.Ulrich Müller2020-01-021-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Replace <path> by <c> throughout.Ulrich Müller2019-12-261-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@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-081-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Drop caption attribute from <pre> elements.Ulrich Müller2019-12-081-4/+4
| | | | | | 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-081-10/+10
| | | | | | Replace by paragraph break, or drop. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix <body> elements.Ulrich Müller2019-12-081-7/+22
| | | | | | | No sectioning elements are allowed inside <body>, according to the devbook guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Avoid absolute (and outdated) /usr/portage path.Ulrich Müller2019-06-171-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>