Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 612494 - devmanual: clarify what type of documentation should be included in DOCS
Summary: devmanual: clarify what type of documentation should be included in DOCS
Status: UNCONFIRMED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: Gentoo Devmanual Team
URL: https://devmanual.gentoo.org/ebuild-w...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-03-13 13:14 UTC by David Hicks
Modified: 2017-03-14 00:05 UTC (History)
1 user (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David Hicks 2017-03-13 13:14:42 UTC
I was looking for information in the devmanual on what type of documentation files should exist in the DOCS variable. For example, does the scope of the DOCS variable include documentation files on the topics of building the source code, installing the software, contributing patches to the upstream project, listing authors, license information, changes/news, general readme files, etc.

It would be helpful to include some clarifying comments and/or examples in the "Ebuild writing > Variables" section of the devmanual to make it clearer what type of documentation should be listed in the DOCS variable.

Reproducible: Always