Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bugzilla DB migration completed. Please report issues to Infra team via email via infra@gentoo.org or IRC
Bug 695870 - improvements to ebuild(5) man page
Summary: improvements to ebuild(5) man page
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Project-specific documentation (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Portage team
URL:
Whiteboard:
Keywords: InVCS
Depends on:
Blocks: 697734
  Show dependency tree
 
Reported: 2019-09-29 15:19 UTC by Daniel Robbins
Modified: 2020-01-17 22:24 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Improvements to the ebuild(5) man page. (ebuild-man-page-fix.patch,11.34 KB, patch)
2019-09-29 15:19 UTC, Daniel Robbins
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Daniel Robbins 2019-09-29 15:19:51 UTC
Created attachment 591246 [details, diff]
Improvements to the ebuild(5) man page.

The following patch contains several formatting improvements, as well as extended information about KEYWORDS that is easier to understand. The original description started describing Gentoo policy on KEYWORDS without actually explaining what they are and how they work.

I have also added missing documentation for the ARCH variable as this was sort of shoe-horned in to the KEYWORDS documentation, and tried to make it clearer what
is a technical requirement of Portage the software and what are Gentoo-specific
arch team requirements.
Comment 1 Larry the Git Cow gentoo-dev 2019-09-29 21:51:46 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage.git/commit/?id=84b9b5c2aea408b9e490b352885891bb3875714d

commit 84b9b5c2aea408b9e490b352885891bb3875714d
Author:     Daniel Robbins <drobbins@funtoo.org>
AuthorDate: 2019-09-29 21:50:18 +0000
Commit:     Zac Medico <zmedico@gentoo.org>
CommitDate: 2019-09-29 21:50:18 +0000

    man/ebuild.5: Improvements to the ebuild(5) man page
    
    The following patch contains several formatting improvements,
    as well as extended information about KEYWORDS that is easier
    to understand. The original description started describing Gentoo
    policy on KEYWORDS without actually explaining what they are and how
    they work.
    
    I have also added missing documentation for the ARCH variable as this
    was sort of shoe-horned in to the KEYWORDS documentation, and tried
    to make it clearer what is a technical requirement of Portage the
    software and what are Gentoo-specific arch team requirements.
    
    Bug: https://bugs.gentoo.org/695870
    Signed-off-by: Zac Medico <zmedico@gentoo.org>

 man/ebuild.5 | 160 +++++++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 116 insertions(+), 44 deletions(-)
Comment 2 Zac Medico gentoo-dev 2019-09-29 21:52:13 UTC
Thanks!
Comment 3 Larry the Git Cow gentoo-dev 2019-10-14 23:01:17 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=e18292c54af86bee8299b6a925d25eb6c55fd77b

commit e18292c54af86bee8299b6a925d25eb6c55fd77b
Author:     Zac Medico <zmedico@gentoo.org>
AuthorDate: 2019-10-14 22:53:35 +0000
Commit:     Zac Medico <zmedico@gentoo.org>
CommitDate: 2019-10-14 23:01:06 +0000

    sys-apps/portage: Bump to version 2.3.77
    
     #220533 Fix FEATURES=skiprocheck read-only DISTDIR support
     #646898 Support GLEP 75 mirror structure
     #658648 Disable emerge --autounmask by default, except for package.use
             and package.license changes
     #695870 Improvements to ebuild(5) man page
    
    Bug: https://bugs.gentoo.org/697734
    Bug: https://bugs.gentoo.org/220533
    Bug: https://bugs.gentoo.org/646898
    Bug: https://bugs.gentoo.org/658648
    Bug: https://bugs.gentoo.org/695870
    Package-Manager: Portage-2.3.77, Repoman-2.3.17
    Signed-off-by: Zac Medico <zmedico@gentoo.org>

 sys-apps/portage/Manifest              |   1 +
 sys-apps/portage/portage-2.3.77.ebuild | 261 +++++++++++++++++++++++++++++++++
 2 files changed, 262 insertions(+)