Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
path: root/eclass-writing
Commit message (Collapse)AuthorAgeFilesLines
* Fix internal referencesUlrich Müller2024-05-071-1/+1
| | | | | | | Internal links referring to sections were broken by the previous "Sentence case devmanual" commit. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Sentence case devmanualMatthew Marchese2024-05-071-12/+12
| | | | | | 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>
* eclass-writing: Some updates from patch reviewUlrich Müller2024-04-241-4/+4
| | | | | | Suggested by mjo and sam. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Formatting fixesUlrich Müller2024-04-241-4/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Add @DEAD tag to tableUlrich Müller2024-04-241-0/+9
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "eclass-writing: @DEAD must be the first tag"Ulrich Müller2024-04-241-3/+1
| | | | | | | | eclass-to-manpages is now less strict about placement of the tag. This reverts commit cd392d0c6cd064ac3a1381111e678f4fe111afcc. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: @USAGE is not requiredUlrich Müller2024-01-141-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal linksUlrich Müller2023-10-301-2/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Use underscores for function names in the exampleUlrich Müller2023-08-261-7/+8
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Drop INCLUDES_EPREFIX documentation tagUlrich Müller2023-05-271-23/+0
| | | | | | This reflects its being dropped from eclass-to-manpage. 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>
* eclass-writing: minor edits to jmake exampleThomas Bracht Laumann Jespersen2022-04-301-3/+3
| | | | | | | | Double space after full stop. Add full stop to sentence. Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> [Wrap paragraph at column 72.] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Sentence ends should be followed by two spacesUlrich Müller2022-04-261-2/+8
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: doc inherit guards, EXPORT_FUNCTIONS warningThomas Bracht Laumann Jespersen2022-04-241-34/+122
| | | | | | | | | | | | | | Add a section to explain what inherit guards are and their usage, and add a "rule of thumb" to put EXPORT_FUNCTIONS at the end of eclasses for max portability. This turned into a larger re-ordering of the sections so the full jmake example can showcase all the features discussed in the preceding sections, like EAPI guard, inherit guard, and EXPORT_FUNCTIONS at the very end. Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: @DEPRECATED must be followed by a colonUlrich Müller2022-03-261-4/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLEUlrich Müller2022-03-231-1/+1
| | | | | Bug: https://bugs.gentoo.org/835396 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Use "required" instead of "not optional"Thomas Bracht Laumann Jespersen2022-03-201-41/+41
| | | | | | | | | | | | When figuring out if a documentation tag is required, the reader must mentally handle "not optional" as "required". Simplify by changing the "optional?" column to "required?". Let us also stop shouting at the reader, so change "YES" and "NO" to "Yes" and "No". Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Rework intro paragraph for jmake exampleThomas Bracht Laumann Jespersen2022-03-181-3/+4
| | | | | | Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Closes: https://github.com/gentoo/devmanual/pull/278 Signed-off-by: Sam James <sam@gentoo.org>
* eclass-writing: Add default src_configure to jmake exampleThomas Bracht Laumann Jespersen2022-03-181-5/+14
| | | | | | | | | | | | The jmake sample eclass was written before EAPI 2 and thus predates src_configure() where configuration and compilation where both handled in src_compile(). Now it makes sense to have a separate jmake_src_configure() that is used as the default src_configure(). Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Signed-off-by: Sam James <sam@gentoo.org>
* eclass-writing: tweak confusing typoSam James2022-03-161-1/+1
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* eclass-writing: fix typo jmake-src_compile -> jmake_src_compileThomas Bracht Laumann Jespersen2022-03-161-1/+1
| | | | | | Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Closes: https://github.com/gentoo/devmanual/pull/277 Signed-off-by: Sam James <sam@gentoo.org>
* Remove references to repomanMatt Turner2022-03-141-2/+1
| | | | | | Bug: https://bugs.gentoo.org/835013 Closes: https://github.com/gentoo/devmanual/pull/274 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* eclass-writing: drop unnecessary '|| die'Sam James2021-12-091-1/+1
| | | | | | newins is already fatal on errors. Signed-off-by: Sam James <sam@gentoo.org>
* eclass-writing: mention CCing maintainers on eclass patchesSam James2021-10-131-0/+6
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: @DEAD must be the first tagUlrich Müller2021-09-041-1/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: More documentation tagsUlrich Müller2021-09-041-4/+26
| | | | | | @SUBSECTION, @SUPPORTED_EAPIS, @PROVIDES, and @DEPRECATED. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: WhitespaceUlrich Müller2021-09-041-138/+46
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Update example for EAPI conditionalUlrich Müller2021-09-021-3/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Fix dashUlrich Müller2021-09-011-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: use BDEPEND for hypothetical jmake exampleSam James2021-04-071-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Remove full stop from table entriesUlrich Müller2021-03-301-43/+43
| | | | | | ::appendices/devbook-guide/#External Coding Style Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: add note re deprecation of eclassesSam James2021-03-301-0/+5
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: add new eclass doc tags for Eclass Function VariablesSam James2021-03-301-51/+39
| | | | | | | | | | Adds: * @USER_VARIABLE * @INCLUDES_EPREFIX * @DEPRECATED Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: add new eclass doc tags for Eclass FunctionsSam James2021-03-301-7/+16
| | | | | | | | | Adds: * @INCLUDES_EPREFIX * @DEPRECATED Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: add new eclass doc tags for Eclass VariablesSam James2021-03-301-37/+50
| | | | | | | | | | | | Adds: * @PRE_INHERIT * @USER_VARIABLE * @OUTPUT_VARIABLE * @INCLUDES_EPREFIX * @DEPRECATED Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: add missing parenthesisSam James2021-03-301-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: adjust example 'inherit' slightlySam James2021-03-301-1/+1
| | | | | | | We don't usually write 'inherit fnord.eclass' but 'inherit fnord'. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: mention pkgcheck usage for checking eclass docsSam James2021-03-301-0/+8
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: mention that prefixing with the eclass name is "namespacing"Sam James2021-03-301-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: mention etiquette with respect to metadata invalidationSam James2021-03-301-0/+11
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: mention that checking (official) overlays may be usefulSam James2021-03-301-1/+4
| | | | | | | | | | | | This is just a politeness/interesting thought which people may want to consider, rather than a hard requirement. For "official" overlays in particular, a Gentoo developer should be able to give the responsible developer(s) a quick ping to ensure they're aware if their overlay seems to be heavily using legacy functionality. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2021-01-031-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: prefer "phase functions" over "ebuild functions"Göktürk Yüksek2020-12-291-2/+2
| | | | | | | | | | When the text specifically refers to phase functions, be more verbose about it. Ebuilds can define other functions that are internal. Eclasses also define functions. Using the term "phase functions" should help clarify the ambiguity. Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/183
* eclass-writing: Update list of eclass examples.Ulrich Müller2020-09-121-3/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove unnecessary escaping of quotes.Ulrich Müller2020-02-161-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright years.Ulrich Müller2020-01-021-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix <body> elements.Ulrich Müller2019-12-081-3/+1
| | | | | | | No sectioning elements are allowed inside <body>, according to the devbook guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Make even more explicit, per gentoo-devMichał Górny2019-09-201-4/+4
| | | | | | | | | | Change 'should' into 'must' for initial reviews. Make it clear that per-package eclass exception applies only to updates. ML-Thread: https://archives.gentoo.org/gentoo-dev/message/122108eebce1c4da00a1838896b4b1c3 Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* eclass-writing: Remove 30-day review requirementMichał Górny2019-08-301-4/+2
| | | | | | | | Remove the requirement of posting API changes for review 30 days prior to committing. It is a dead policy, and we currently perform such changes with regular review periods. Signed-off-by: Michał Górny <mgorny@gentoo.org>
* eclass-writing: Word review requirement more stronglyMichał Górny2019-08-301-11/+11
| | | | | | | | Make the review of eclass updates an explicit requirement rather than strong suggestion. Require them unconditionally, providing explicit exception for per-package eclasses. Signed-off-by: Michał Górny <mgorny@gentoo.org>